[Improve Existing Best Practice Guide]: Documentation Organization Ref Architecture
Open
@Scotchester is already working on this.
Since Jan 12, 2023.
- #30 by @riverma — closed without merging
information sharing
medium complexity
requested
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Best Practice Guide
Documentation
Best Practice Guide Sections
Reference Architectures
Describe the improvement
We need some sample reference architectures for recommending how documentation created for a project should be organized. This involves documentation artifacts like user guides, dev guides, etc., and how they can be organized to make it most efficient for users and developers to find those resources.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.