Skip to content
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

Merged
merged 2 commits into from
Jul 15, 2021

Conversation

minkyraccoon
Copy link
Contributor

@minkyraccoon minkyraccoon commented Jul 15, 2021

This ADR proposes a documentation strategy for 4 specific use cases for documentation and the proposed structure using GitHub as the Content Management System.

@minkyraccoon minkyraccoon added the documentation Improvements or additions to documentation label Jul 15, 2021
@minkyraccoon minkyraccoon self-assigned this Jul 15, 2021
Copy link
Contributor

@PaddyMc PaddyMc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@barriebyron barriebyron left a 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!

docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
@barriebyron
Copy link
Contributor

food for thought @SenorMonito
Perhaps add some language to add flexibility to achieve the best outcome, following https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines

Copy link
Contributor Author

@minkyraccoon minkyraccoon left a 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

docs/architecture/adr-002-docs-structure.md Outdated Show resolved Hide resolved
@minkyraccoon minkyraccoon merged commit e607bf7 into main Jul 15, 2021
@minkyraccoon minkyraccoon deleted the docs/adr-002-docs-strategy branch July 15, 2021 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants