documentation-criteria-3f90c4 — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited documentation-criteria-3f90c4 (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
This skill owns document routing: which durable decisions the change needs to record and where each document lives. Each template linked from Storage Locations owns the document's content and structural requirements.
Accepted records the currently selected means, not an obligation to retain it: when later evidence supports a smaller sufficient choice, update or supersede the ADR while the confirmed outcome, desired-future requirements, and non-goals remain true. Complete implementation design belongs in the Design Doc| Structural Scale | Base Documents | Creation Order |
|---|---|---|
| Small | None | Direct implementation |
| Medium | Design Doc, Work Plan | Design Doc -> Work Plan |
| Large | PRD, Design Doc, Work Plan | PRD -> Design Doc -> Work Plan |
Add a UI Spec before the Design Doc for frontend/fullstack work when its decisions remain open. Complete any qualifying ADR batch before the Design Doc. A qualifying ADR raises the scale to Medium at minimum.
For a Large change, satisfy the PRD requirement by creating a new PRD, updating the relevant PRD, or creating a reverse PRD when no current product document exists. At any scale, update an existing PRD when the product scope changes.
Classify decision burden rather than repository layout. File count is supporting evidence only.
| Scale | Decision burden |
|---|---|
| Small | One coherent outcome, one evident repository-supported implementation within one responsibility boundary, and no unresolved durable choice |
| Medium | One coherent outcome that coordinates a boundary or contains a potentially durable choice |
| Large | Multiple independently valuable outcomes that require separate design decisions |
A cross-layer implementation can remain Medium when it serves one coherent outcome.
Apply the Choice filter, then the Durability filter, to each technical topic inside the confirmed implementation scope. Check accepted ADRs before creating another record.
Create one ADR for each topic that passes both filters and review the complete batch together. Group choices that must be selected or reconsidered together; separate independently revisitable decisions. Local implementation details and other cheaply reversible choices belong in the Design Doc.
| Document | Path | Naming Convention | Template |
|---|---|---|---|
| PRD | docs/prd/ | [feature-name]-prd.md | prd-template.md |
| ADR | docs/adr/ | ADR-[4-digits]-[title].md | adr-template.md |
| UI Spec | docs/ui-spec/ | [feature-name]-ui-spec.md | ui-spec-template.md |
| UI Spec Assets | docs/ui-spec/assets/{feature-name}/ | Prototype code files | - |
| Design Doc | docs/design/ | [feature-name]-design.md | design-template.md |
| Work Plan | docs/plans/ | YYYYMMDD-{type}-{description}.md | plan-template.md |
| Task File | docs/plans/tasks/ | {plan-name}-task-{NN}.md (backend-only plan); {plan-name}-backend-task-{NN}.md (backend in a mixed-layer plan); {plan-name}-frontend-task-{NN}.md (frontend) | task-template.md |
Every placeholder substituted into a generated directory or file name must be a lowercase ASCII kebab-case slug. Convert non-ASCII source text to that form before constructing the path.
Work Plans are excluded by .gitignore.
Each template defines its document's content, status rules, required evidence, optional diagrams, and completion checks. Load only the template for the document being created or reviewed.
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.