Skip to content

Instantly share code, notes, and snippets.

@lorne-luo

lorne-luo/documentation process.md

Created April 24, 2018 05:46
Show Gist options
  • Save lorne-luo/5dfa0beb6d43ef9510ece7e07490082b to your computer and use it in GitHub Desktop.
Save lorne-luo/5dfa0beb6d43ef9510ece7e07490082b to your computer and use it in GitHub Desktop.
Download ZIP
[Butterfly] Documentation process
Raw
documentation process.md

For each project, dev team should have two kinds of documentation:

  1. documentation for project
  2. documentation for problem-solving which could share with team

Documentation for project

This part should be done in README.md of project root, the content should include:

  1. How to setup/config/build/test/deploy
  2. Brief architecture design
  3. Note for third-party service integration
  4. Troubleshooting

Here is a good example README.md from Reform Clothing, if the topic is too big you can create a docs folder to include these doc files and refer it in README.md

Documentation for problem-solving

If project has some technical problem-solving cases (or any investigation/knowledge/creation) which is worth sharing with the team, we should document it in this way:

  1. Create a wiki page under this project's gitlab
  2. For each kind of language/framework, we will have a knowledge collection page, attach this wiki page's URL in a corresponding collection page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment