Welcome to the WatchTower documentation index. This folder contains all project documentation needed to understand, develop, and maintain the WatchTower observability platform.
New here? Start with the Onboarding Guide for a hands-on quick start, repo tour, and build/test walkthrough, then come back to this index for the deep dives.
This documentation directory serves as the single source of truth for:
Our documentation is organized by purpose to make it easy to find what you need:
Define what we’re building and for whom.
Track progress, manage the backlog, and run sprints effectively. See the planning index for all sprint docs.
Establish and document how we work together.
Document discovery, experimentation, and design thinking. See the research index.
Visual and interactive design specifications. See the design index.
Record major technical decisions and trade-offs. See the architecture index.
Preserve team discussions and decisions.
| Document | Purpose |
|---|---|
| Onboarding Guide | Hands-on quick start, repo tour, build/test walkthrough |
| Project Brief | Get up to speed on what WatchTower is |
| Requirements | Understand detailed feature specifications |
| Sprint Planning | See current sprint goals and assignments |
| Git Workflow | Review branching and commit conventions |
| Decision Log | Track important project decisions |
To keep our documentation useful and maintainable, please follow these standards:
sprint-planning.md, not Sprint Planning.md)[#123](https://github.com/org/repo/issues/123)[PR #456](https://github.com/org/repo/pull/456)[See Product Brief](/Watchtower-Course-Project/docs/product/project-brief.html)#, ##, etc.) for structure| Scenario | What to Update |
|---|---|
| Adding a new feature | Requirements, Sprint notes |
| Changing architecture | Architecture Decision Records |
| Making a team decision | Decision Log |
| Completing a sprint | Retrospectives, backlog |
| Discovering something new | Research folder or relevant document |
| Changing the workflow | Process docs |
| Blocked or discovering an issue | Standups |
Every team member contributes to documentation as part of their work:
Key principle: The person who makes a change is responsible for updating the related documentation.