# Documentation Standard (Streamlit)

Last update: 2026-02-23

## Goal
This file defines the writing standard for all in-app documentation pages in `documentations/*.py`.

## Required Sections (for every page)
1. Objective
2. When to use this tool
3. Input files and accepted formats
4. Required columns/fields (if applicable)
5. Step-by-step usage
6. Outputs generated
7. Frequent errors and fixes
8. Minimal reproducible example
9. Known limitations
10. Version and last update date

## Writing Rules
- Write for end users first.
- Keep examples concrete and copy/paste friendly.
- Keep naming aligned with UI labels and button names.
- Avoid implementation details unless they help troubleshoot user issues.
- Include exact file extensions (`.xlsb`, `.xlsx`, `.csv`, `.txt`).

## Quality Checklist
- [ ] All 10 required sections are present.
- [ ] File formats are explicit.
- [ ] Required columns are listed exactly as expected by the app.
- [ ] At least 3 frequent user errors are documented.
- [ ] One minimal example is provided.
- [ ] A date is present in the page.

## Naming Convention
- File name: `<tool_name>_doc.py`
- Page title in navigation: `<Tool Name> Documentation`

## Review Process
1. Verify the doc against the actual page in `apps/`.
2. Open the Streamlit page and confirm terminology matches UI.
3. Update `documentations/DOC_COVERAGE.md` status.