mirror of https://github.com/azaion/detections.git synced 2026-04-22 22:06:32 +00:00

Files

T

Oleksandr Bezdieniezhnykh d28b9584f2 Generalize tracker references, restructure refactor skill, and strengthen coding rules

- Replace all Jira-specific references with generic tracker/work-item
  terminology (TRACKER-ID, work item epics); delete project-management.mdc
  and mcp.json.example
- Restructure refactor skill: extract 8 phases (00–07) and templates into
  separate files; add guided mode for pre-built change lists
- Add Step 3 "Code Testability Revision" to existing-code workflow
  (renumber steps 3–12 → 3–13)
- Simplify autopilot state file to minimal current-step pointer
- Strengthen coding rules: AAA test comments per language, test failures as
  blocking gates, dependency install policy
- Add Docker Suitability Assessment to test-spec and test-run skills
  (local vs Docker execution)
- Narrow human-attention sound rule to human-input-needed only
- Add AskQuestion fallback to plain text across skills
- Rename FINAL_implementation_report to implementation_report_*
- Simplify cursor-meta (remove _docs numbering table, quality thresholds)
- Make techstackrule alwaysApply, add alwaysApply:false to openapi

2026-03-28 02:42:36 +02:00

2.1 KiB

Raw Blame History

Phase 7: Documentation Update

Role: Technical writer Goal: Update existing _docs/ artifacts to reflect all changes made during refactoring Constraints: Documentation only — no code changes. Only update docs that are affected by refactoring changes.

Skip condition: If no _docs/02_document/ directory exists, skip this phase entirely.

7a. Identify Affected Documentation

Review RUN_DIR/execution_log.md to list all files changed during Phase 4
Review test changes from Phase 5
Map changed files to their corresponding module docs in _docs/02_document/modules/
Map changed modules to their parent component docs in _docs/02_document/components/
Determine if system-level docs need updates (architecture.md, system-flows.md, data_model.md)
Determine if test documentation needs updates (_docs/02_document/tests/)

7b. Update Module Documentation

For each module doc affected by refactoring changes:

Re-read the current source file
Update the module doc to reflect new/changed interfaces, dependencies, internal logic
Remove documentation for deleted code; add documentation for new code

7c. Update Component Documentation

For each component doc affected:

Re-read the updated module docs within the component
Update inter-module interfaces, dependency graphs, caveats
Update the component relationship diagram if component boundaries changed

7d. Update System-Level Documentation

If structural changes were made (new modules, removed modules, changed interfaces):

Update _docs/02_document/architecture.md if architecture changed
Update _docs/02_document/system-flows.md if flow sequences changed
Update _docs/02_document/diagrams/components.md if component relationships changed

Self-verification:

Every changed source file has an up-to-date module doc
Component docs reflect the refactored structure
No stale references to removed code in any doc
Dependency graphs in docs match actual imports

Save action: Updated docs written in-place to _docs/02_document/

2.1 KiB Raw Blame History