top of page

Everything about guides on antscihub

Writer's picture: Kendrick NakamuraKendrick Nakamura

Updated: Sep 15, 2024

🚧 Work in progress 🚧

This guide covers:

  1. How to make a guide blog post.

  2. How a guide is written.

  3. How we make sure the guide is used.


Overview

Guides on AntSciHub have two components: the top level, question-centered blog post, and the solicitation of community experts to post their insights and cover nuance on the forum.


Top level posts are optimized for sharing and immediate results, whereas forum posts are meant to maximize inclusion and answer depth.


Theory and concepts used in this guide


Step by step

  1. Prepare the blog post

    1. Set the cover image

    2. Set the SEO blurb (ChatGPT is great for this)

  2. Write the post

    1. A title should fully frame the question

      1. Check against ChatGPT and other tools for this.

    2. Motivate the question

      1. Give real examples of the answer being used

      2. Elaborate more broadly for what it could be used for.

    3. Frame a general answer and a nuanced answer

      1. What are the requirements for a complete answer?

      2. What are the general answers?

      3. What should a nuanced answer include?

    4. Answer the question

      1. Give the broad answer to the question

      2. List the different nuances of the question

  3. Invite the community to participate to cover the nuances on the forum

    1. Work with experienced and knowledgable people in the community and see if they would be willing to write a guide for specific answers.

    2. Once you have a few people willing to cover your blindspots or areas you don't know about, ask them what kind of nuance is important to make sure the main post covers it properly.

    3. Work with people to fix thread titles so that they contain the most important information.


Making sure your guide is found

  • Add commands to summon the guide on discord.

  • Add keywords to summon the guide on reddit.

  • Please coordinate with me to discuss this.


Hints to make a useful guide

  • Consider your audience, and write for as many different audiences as you can.

  • Good writing is clear and concise.

  • Do a pre-mortem.

  • Concepts that might be unfamiliar to the reader can be linked 😄

  • For scientific concepts, be sure to link to papers directly.

  • Put elaboration on content into collapsible containers, especially if it isn't critical to understanding the content.

Comments


bottom of page