Curated Skills
by lstudlo

documenting

references/document-quality-checklist.md

.md 30 lines
Content
# Document Quality Checklist

Use this checklist before finalizing either mode.

## Shared Checks

- The title is specific.
- The path follows the required convention.
- The doc has an owner and status.
- The summary answers the core question quickly.
- Repeated context has been removed.
- Links are used instead of pasted support material.

## Feature Spec Checks

- The problem is clear before requirements appear.
- Goals and non-goals are distinct.
- Requirements are concrete and one sentence each where possible.
- The mental model is short and explicit.
- Open questions are blockers only.
- Vague adjectives and generic framing have been removed.

## Technical Design Checks

- The proposed design is tied to explicit goals and constraints.
- Interfaces, boundaries, or data flow are clear enough for review.
- Alternatives are included only when the decision is non-obvious.
- Risks and rollout concerns are recorded when relevant.
- Background is trimmed to only what affects the design.