Skip to content
Thorben Westerhuys edited this page Jan 6, 2021 · 5 revisions

Welcome to the handbook wiki!

Wikis provide a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.

The Process

  1. daily Spend 15 - 30 minutes at the end of each day or beginning of next day to upload some of your notes (from WHEREVER you took them - Trello, Slack, README, scrap of paper...) into this wiki. Don't worry about syntax, grammar or structure. Just create a page for the topic that you were working on and write something down.

  2. weekly Once a week, we go through the new wiki pages from ourselves and team members and thumbs up things we find useful/interesting/want more of, through a comment or edit making some suggestions or improvements. Through this, we try to identify topics which are "ripe" for becoming proper (user facing) documentation.

  3. sprint We do a regular documentation sprint, where the wiki pages are compiled and properly formatted etc. to create documentation pages that are part of the handbook code repository.

Review Status

  • Current Cycle: Jan 4 - 8, 2021

Under Review

See corresponding discussion thread for rating and commenting