Definition of good documentation
- Dominant language
- Java
- Stars
- 107
- Forks
- 29
- Avg merge
- 19h 46m
- Merged PRs (30d)
- 141
Description
We'd like a definition of what good documentation looks like in the project. This can go under development documentation, and be linked to from the developer guide.
We've got something like this for Javadoc, in the coding conventions document, but we don't have anything for our Markdown documents.
#### Potential inclusions
Heading capitalisation / nesting structure.
Number of columns in a table.
Avoid including too much information inside a single table cell.
Avoid adding too many links that could be broken, consider how to avoid broken links.
Contributor guide
Research direction
Start by reading the existing coding conventions document and developer guide to find the appropriate development-documentation location and linking style. Add a Markdown documentation standard covering the listed heading, table, and link guidance, then link it from the developer guide and verify the documentation links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100