-
Notifications
You must be signed in to change notification settings - Fork 12
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
feat(ADR): Documentation Strategy (#129) #152
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SenorMonito I love this formal approach! In past jobs, we have adhered to 3 primary content types: concept (called Explanation by Divio), task (how-to), and reference. Tutorials were managed by another group since tutorials are closely tied to software release versions and typically include assets required to run code for that particular release.
This documentation strategy is a wonderful step in a good direction. Be proud!
I provided more editorial suggestions, but went ahead and approved so you can merge it after you commit the changes you agree with. Cheerio!
food for thought @SenorMonito |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on reviewer feedback. moving to accepted status
Co-authored-by: Barrie Byron <[email protected]>
This ADR proposes a documentation strategy for 4 specific use cases for documentation and the proposed structure using GitHub as the Content Management System.