Four kinds of documentation
- learning-oriented tutorials
- goal-oriented how-to guides
- understanding-oriented discussions
- information-oriented reference material
Source: The four kinds of documentation, and why you need to understand what they are¶
cources
tool
- https://next-smooth-doc.vercel.app
- GitHub - arc53/docsgpt: Use documentation and ask questions directly with DocsGPT
- GitHub - souporserious/renoun: The Documentation Toolkit for React
- GitHub - AsyncFuncAI/deepwiki-open: Open Source DeepWiki: AI-Powered Wiki Generator for GitHub/Gitlab/Bitbucket Repositories. Join the discord: https://discord.gg/gMwThUMeme
- Fumadocs
Links
- https://jvns.ca/blog/brag-documents/
- There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are: tutorials, how-to guides, technical reference and explanation.
- How to write a readme
- documentation Standard Example: Dendorn
- https://github.com/hackergrrl/art-of-readme
- From README to documentation site in 10 minutes using https://docsify.js.org/
- Diátaxis - A systematic framework for technical documentation authoring.