doc-skill

name	doc skill
description	describe how to write documentation

documentation best practices

the document outlines the best practices for writing all kinds of documentation, for example, architecture design doc, user story doc and postmortem doc

when to use this skill

when you need to write documentation

best practices

• you should always insert some blank lines between paragraph, for better readibility
• you should always try to use markdown if possible
• you should always try to use bullet point, blockquote and headline to organize your doc if using markdown
• you should try to use simple term, easy to understand wording when writing doc
• when writing doc, you should always include "why" in the first place
• the "why" section should cover all background knowledge associated with the doc, to help user better understand the context
• following the "what" section describe what this doc try to elaborate