We like to keep our documentation under revision control and in the same repository as our source code. These templates reflect some of the different types of documentation that we typically include on our projects:
- Common open-source documentation (README, CONTRIBUTING, GitHub templates)
- Architecture and requirements documentation templates
- "Business-level" documentation templates, such as stakeholder profiles, differentiation strategy, and risk profiles
- Jenkins CI pipelines, showing both a "CI" build variant and a "nightly" build variant
We hope these templates enable you to write better documentation for your own projects!
Updates, edits, and contributions are welcome from all.
For more on project documentation:
- Your Project is Great, So Let's Make Your README Great Too
- Get Others Involved in Your Project with a CONTRIBUTING Guide
For more information on these templates:
- Embedded Artistry README Template
- Embedded Artistry CONTRIBUTING Template
- A GitHub Issue Template for Your Projects
- A GitHub Pull Request Template for Your Projects
- A GitHub Pull Request Template for the CCC Process
Resources that can serve as inspiration for creating your own documentation:
- Open Source Contribution Guide
- Source Control Commit Guidelines
- Code Change Control (CCC) Template
- Embedded Artistry's GitHub Process
- Embedded Artistry Code of Conduct
#end