Agentic-AI-Template/Document/README.md

Report Generation Harness Template

Codex-first template for creating evidence-backed reports through staged research, drafting, user feedback, and revision.

How To Use

1. Fill in docs/PRD.md with the report topic, purpose, keywords, direction, audience, and output format.
2. Run the default phase with python scripts/execute.py 0-report-generation, or ask Codex to plan a custom report phase with the repo harness-workflow skill or /harness command.
3. Review docs/RESEARCH_LOG.md and docs/REPORT_DRAFT.md.
4. Add user feedback to docs/FEEDBACK.md, then run the next revision phase.

Core Files

• AGENTS.md: persistent report-generation rules.
• docs/PRD.md: report brief and required user input.
• docs/ARCHITECTURE.md: report workflow and artifact architecture.
• docs/ADR.md: research and writing decisions.
• docs/UI_GUIDE.md: report style guide.
• docs/RESEARCH_LOG.md: accumulated web research and source notes.
• docs/REPORT_DRAFT.md: current report draft.
• docs/FEEDBACK.md: feedback and revision log.

Commands

python scripts/validate_workspace.py
python scripts/execute.py 0-report-generation
python scripts/execute.py 0-report-generation --push