- Create SECURITY.md to outline security policies and practices. - Establish WORKFLOW.md detailing the project lifecycle from planning to retrospective. - Introduce decision log structure in decisions/README.md for tracking architecture decisions. - Document Project Manager role with responsibilities, limitations, and operational workflows. - Implement templates for ADRs, bugs, meetings, projects, retrospectives, RFCs, roadmaps, and sprints. - Set up memory logs for architecture and company-wide lessons learned. - Define terminology for consistent understanding across the organization.
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# <Project Name>
|
|
|
|
**Status:** Planning | Active | Paused | Complete
|
|
**Epic:** link to the Plane Epic this project executes
|
|
**Gitea repo:** `<ORG_NAME>/<repo-name>`
|
|
|
|
## Summary
|
|
|
|
One paragraph: what this project is and why it exists. Should trace back to the Founder-approved
|
|
plan that created its Epic (`FOUNDER.md`).
|
|
|
|
## Scope
|
|
|
|
What's in. What's explicitly out — scope boundaries matter as much as the goal itself, since
|
|
scope creep inside an approved Epic is one of the things `WORKFLOW.md` asks engineers and the
|
|
Architect to actively watch for.
|
|
|
|
## Architecture
|
|
|
|
High-level design. Link out to relevant ADRs (`decisions/`) rather than restating their
|
|
reasoning here — this section should read as a map, not a duplicate of the decision log.
|
|
|
|
## Roles involved
|
|
|
|
Which engineering disciplines this project needs (not every project needs all of them) and
|
|
anything project-specific about how they collaborate beyond what `ORGANIZATION.md` already
|
|
covers.
|
|
|
|
## CI / deployment notes
|
|
|
|
Anything about this project's ACT Runner configuration or deployment pipeline that goes beyond
|
|
the default in `ACT_RUNNER.md`.
|
|
|
|
## Status log
|
|
|
|
Brief dated entries at major milestones — not a duplicate of Plane's burndown, just enough for
|
|
someone reading this file cold to understand the project's trajectory.
|
|
|
|
- YYYY-MM-DD — <milestone>
|