Projects and Repositories
Every source code repository should include documentation that is specific to it (e.g., in a Wiki within the repository), while the project itself should include general documentation that is common to all its associated repositories (e.g., in a Wiki within the backlog management tool).
Documentation specific to a repository
- Introduction
- Getting started
- Onboarding
- Setup: programming language, frameworks, platforms, tools, etc.
- Sandbox environment
- Working agreement
- Contributing guide
- Structure: folders, projects, etc.
- How to compile, test, build, deploy the solution/each project
- Different OS versions
- Command line + editors/IDEs
- Design Decision Logs
- Architecture Decision Record (ADRs)
- Trade Studies
Some sections in the documentation of the repository might point to the project’s documentation (e.g., Onboarding, Working Agreement, Contributing Guide).
Common documentation to all repositories
- Introduction
- Project
- Stakeholders
- Definitions
- Requirements
- Onboarding
- Repository guide
- Production, Spikes
- [Crew Contracts]](../../agile_guide/beyond_the_basics/crew_contracts)
- Crew Manifesto
- Short summary of expectations around the technical way of working and supported mindset in the team.
- E.g., ownership, respect, collaboration, transparency.
- Working Agreement
- How we work together as a team and what our expectations and principles are.
- E.g., communication, work-life balance, scrum rhythm, backlog management, code management.
- Definition of Done
- List of tasks that must be completed to close a user story, a sprint, or a milestone.
- Definition of Ready
- How complete a user story should be in order to be selected as candidate for estimation in the sprint planning.
- Contributing Guide
- Repo structure
- Design documents
- Branching and branch name strategy
- Merge and commit history strategy
- Pull Requests
- Code Review Process
- Code Review Checklist
- Project Design
- High Level / Game Plan
- Milestone / Epic Design Review
- Design Review Recipes
- Milestone / Epic Design Review Template
- Feature / Story Design Review Template
- Task Design Review Template
- Decision Log Template
- Architecture Decision Record (ADR) Template (Example 1, Example 2)
- Trade Study Template