doc: reafirmed project goals and direction

This commit is contained in:
2026-06-02 17:07:03 +01:00
parent 6eef97582d
commit 13f5e10f6f
6 changed files with 127 additions and 17 deletions
+86 -2
View File
@@ -230,7 +230,91 @@ Acceptance Criteria:
Result:
Two new guardrail checks added:
- `check_repeated_commands_telemetry` — uses session-log.jsonl to detect repeated CLI commands (>3x)
- `check_repeated_reads_telemetry` — uses session-log.jsonl to detect repeated file reads (>3x)
Both integrate into `run_all_guardrails` alongside existing heuristic checks.
When telemetry data is absent, both return `"ok"` with an informative fallback message instead of failing.
Both integrate into `run_all_guardrails` alongside existing heuristic checks.
When telemetry data is absent, both return `"ok"` with an informative fallback message instead of failing.
## TASK-015 — Re-centre project purpose
Status: Done
Goal:
Clarify that rdb-discovery exists to help generate and maintain useful project context files for AI-assisted development.
Implementation Gap:
The project now has task, prompt, guardrail, and telemetry features, but the core product purpose needs to be made explicit again.
Acceptance Criteria:
- Update README.md with a clear project purpose
- Explain the core workflow:
- ask discovery questions
- capture answers
- generate context files
- support agent implementation
- Clarify that telemetry and guardrails support the workflow but are not the main product
- Add/update tests only if required
## TASK-016 — Define standard context file templates
Status: Todo
Goal:
Define the standard context files that rdb-discovery should help generate.
Implementation Gap:
There is not yet a clear built-in definition of the context files the tool should produce.
Acceptance Criteria:
- Define templates for:
- company-context.md
- development-context.md
- infrastructure-context.md
- agent-guidelines.md
- project-brief.md
- architecture.md
- Templates include headings and placeholder guidance
- Keep templates simple markdown
- Add/update tests
## TASK-017 — Generate context files from discovery answers
Status: Todo
Goal:
Use captured discovery answers to generate initial context files.
Implementation Gap:
Discovery questions can collect information, but the answers are not yet transformed into structured project context documents.
Acceptance Criteria:
- Add command or function to generate context files from discovery data
- Create missing context files safely
- Do not overwrite existing files without explicit behaviour
- Add/update tests
## TASK-018 — Add context completeness report
Status: Todo
Goal:
Report which expected context files exist and which sections still need information.
Implementation Gap:
There is no way to see whether a project has enough context for an AI agent to work effectively.
Acceptance Criteria:
- Add a context status/check command
- Report present context files
- Report missing context files
- Report obvious placeholder sections still needing completion
- Add/update tests