This directory contains all project documentation following the BMad Method workflow structure, inspired by modern software development best practices.

Product Strategy (What & Why)
  ↓
Requirements (What to Build)
  ↓
Architecture (How to Build)
  ↓
Implementation (Development)
  ↓
Deployment & Operations

1. Product Brief defines "WHY and WHAT"

• Market positioning and competitive analysis
• Target users and use cases
• Business value and success metrics
• High-level feature priorities

2. PRD defines "WHAT to build" (functional requirements)

• Detailed feature specifications
• Acceptance criteria
• User stories
• Non-functional requirements

3. Architecture defines "HOW to build" (technical approach)

• Technology stack decisions
• System design and component integration
• Data architecture and API design
• Security and performance strategies

Purpose: Define product vision, market fit, and strategic direction

Key Sections:

• Executive Summary
• Problem Statement & Market Analysis
• Proposed Solution & Differentiators
• Target Users & Use Cases
• Competitive Positioning
• Go-to-Market Strategy
• Roadmap

Audience: Executives, investors, product team

Purpose: Detailed functional and non-functional requirements

Key Sections:

• Core Functional Requirements (FR-XXX-XXX)
• Non-Functional Requirements (NFR-XXX)
• User Stories & Acceptance Tests
• MVP Scope & Priorities
• Integration Requirements

Audience: Development team, QA team, product managers

Purpose: System design and implementation approach

Key Sections:

• Architecture Overview & Technology Stack
• Component Architecture (Cockpit, AppHub, Docker, etc.)
• Data Architecture & API Design
• Security Architecture
• Performance & Scalability
• Deployment Architecture
• Architecture Decision Records (ADRs)

Audience: Architects, senior developers, DevOps

Purpose: How to contribute and develop Websoft9

Contents:

• Development setup
• Coding standards
• Release process
• Testing guidelines

Audience: Contributors, development team

Purpose: How to use and troubleshoot Websoft9

Contents:

• FAQ
• Common issues and solutions
• Best practices

Audience: End users, support team

Purpose: Project governance and maintenance processes

Contents:

• Team roles and responsibilities
• Pull request workflow
• Issue triage
• Release management

Audience: Core maintainers

1. Start with Product Brief to understand strategic direction
2. Reference PRD for detailed requirements
3. Track progress using GitHub Issues/Projects

1. Read Architecture to understand system design
2. Follow Developer Guide for coding standards
3. Refer to PRD for acceptance criteria
4. Check API Documentation for API specs

1. Read README.md for project overview
2. Review Developer Guide for setup instructions
3. Check MAINTAINERS.md for contribution process
4. Start with issues labeled good first issue

1. Start with User Guide for FAQs
2. Check Product Brief for feature roadmap
3. Join community channels for support

1. Clarity Over Cleverness: Write for understanding, not to impress
2. Actionable Content: Every document should enable a decision or action
3. Consistent Structure: Follow established templates and formats
4. Living Documents: Update as product evolves

# H1 - Document Title (one per document)
## H2 - Major Sections
### H3 - Subsections
#### H4 - Details

**Bold** for emphasis
*Italics* for terminology
`code` for commands and code references

All major documents should include frontmatter:

---
title: Document Title
author: Team Name
date: YYYY-MM-DD
status: Active | Draft | Deprecated
version: X.Y
---

• Websoft9 Core
• Docker Library - Application templates
• Cockpit Plugins - UI extensions

• Cockpit Project
• Docker Documentation
• FastAPI Framework
• Nginx Proxy Manager

• Demo Server - Try Websoft9 live
• Slack Workspace - Community chat
• GitHub Discussions - Q&A forum

• Found a typo or outdated information? Open an issue
• Want to improve a section? Submit a pull request

Before submitting:

1. Check spelling and grammar
2. Verify links are working
3. Test code examples
4. Follow existing structure and style
5. Update table of contents if needed

Review process:

• Documentation PRs reviewed by core team
• Merged within 7 days (for minor updates)
• Technical content requires architect approval

• Major updates: Increment version number (1.0 → 2.0)
• Minor updates: Update date only
• Deprecated docs: Move to docs/archived/ with deprecation notice

We track documentation effectiveness through:

• Completeness: All sections filled, no TODO placeholders
• Accuracy: Content reflects current implementation
• Findability: Searchable, well-indexed, clear structure
• Usability: Easy to read, actionable, well-formatted
• Feedback: User ratings, issue reports, support tickets reduced

Last Updated: 2026-01-04
Maintained By: Websoft9 Documentation Team
Next Review: 2026-04-01

For questions or suggestions about this documentation, please open an issue or contact the documentation team.