Skip to content

Document templates for open-source projects (README, CONTRIBUTING, GitHub templates)

License

Notifications You must be signed in to change notification settings

chantal-kelm/templates

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Embedded Artistry templates

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.

References & Resources

For more on project documentation:

For more information on these templates:

Resources that can serve as inspiration for creating your own documentation:

#end

About

Document templates for open-source projects (README, CONTRIBUTING, GitHub templates)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Groovy 100.0%