-
Notifications
You must be signed in to change notification settings - Fork 202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Kinds of Documentation #8
Comments
I decided to name it I think this system is great and would like to follow this. What do you guys think? |
sounds good. I guess we might sometimes have a hard time to choose between recipes and tutorials but... x) |
Yeah, it's difficult and the article explains that's why writing a good documentation is difficult. I'd recommend reading https://documentation.divio.com/introduction, but here's my understanding: Recipes (How-to guides in the linked article) show how to solve a specific goal. The reader isn't new to the topic itself, but looking for a solution for a problem within it. Recipes should present the problem and the solution for it. It can also include some discussions on the problem. Tutorials are for newcomers. We need to familiarize the reader with the topic. We need to walk them through all the necessary steps and let them learn how things work. Tutorials should only include the necessary information for each step to prevent overwhelming the reader.
|
We should write documentation with purpose and target audience in mind.
docs/data/kinds.yml
Lines 9 to 36 in 409a7cd
Reference: https://documentation.divio.com/
The text was updated successfully, but these errors were encountered: