How to Make a Wiki Help Guide - barrycumbie/solid-fishstick-snowcats GitHub Wiki

As a REPO contributor

I want to create and use product & process documentation

So that I generate knowledge, pay it forward (to myself), & DRY

Some Tips!

  • Wiki Title: Clear, actionable, semantic. (no names or dates, keep universal)
  • sure,your names in sub-title, dates, context. Sure.
  • Who is using this and for what purpose? User stories help but are not required, as long as info is conveyed.
  • Use BIG headers # and ## for steps. (they make subheaders in the wiki nav)
  • Use emoticons! Color and pics help deliniate parts of your doc. 1️⃣ 2️⃣ 💰 (for the end...the 'payoff')
  • Use shorter titles for numbered steps: "1. Get Node.js" vs. "1. To start, we need to first get Node." The latter is good for a description right below the header.
  • Here a good end message: "Congrats! 🎉 You finished the process building and test your web applications on localhost! 🥳"
  • how to name tech and tools? Like, always say Node.js vs. node and even git or GitHub.
  • careful for non-standard language: explain things like git salute 🫡
  • crop, annotate images. Border too?
  • put all assumptions, inputs, starting points at the top. Is this for windows users? make that known: **Cloning a GitHub REPO on a Windows devBox🪟 💻 **
  • don't intermix numbers: step 1. then 1...2...3..
  • screenshot and triple backtick code syntax highlight? Yessss.
  • test! did your headers fire (no space) or bold not work (extra space)
  • orient us. Where are we. On Cloud, internet, browser. On our devBox... on a site?
  • indent sections (images), quote text.
  • entire page for tiny annotation? Mabye a big arrow or show big page, then smaller screen shots.