Skip to content

maciek1839/project-templates

Repository files navigation

Project templates

Examples of README files for various projects, Confluence pages and ADRs.

ADR (Architecture Decision Record)

An architecture decision record (ADR) is a document that captures an important architecture decision made along with its context and consequences.

Homepage of the ADR GitHub organization: https://adr.github.io/

Reference: https://github.com/joelparkerhenderson/architecture-decision-record

General

A general-purpose ADR template.

Confluence

General

A general-purpose Confluence structure for project's documentation.

General-purpose template

README

General

A general-purpose README contains basic information about a medium-sized project. The template can be easily customizable by removing redundant sections. For a big-sized project I recommend to use Confluence where you can put all necessary information and all the teams can update the documentation (make a README file simple keeping some basic information like a technology stack or a project setup including links to Confluence if necessary).

General-purpose template

Gitlab template

Demo

A demo README which might be useful for demo/poc (proof of concept) projects.

Demo template

About

Examples of README files for various projects, Confluence pages and ADRs.

Topics

Resources

License

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors