document-writer-reviewer
Skill1 starsChanged 8 days agoMITView on GitHub
Review, rewrite, and normalize software delivery documents — BRDs, PRDs, FSDs/FRDs, NFRs, TRDs, ADRs, SADs, Epics/Stories, runbooks/postmortems, and developer handoff packages. Use when a document is incomplete, inconsistent, weakly structured, or needs to be upgraded into a cleaner, more traceable artifact. Trigger on: "review this document", "improve this doc", "rewrite this spec", "make this cleaner", "this needs polish", "review my BRD / PRD / FSD / NFR / TRD / ADR / SAD / epic / runbook", "audit this document", "what's missing from this spec", or any request to evaluate and strengthen a software delivery document.
We split this skill into the rules it gives an agent
10 rules. About 0 are common, 9 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈9
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 15
Use this skill to turn raw notes, uneven drafts, or weakly governed delivery documents into cleaner artifacts that teams can review, …
- Distinctive: line 48
If the artifact type is unclear, infer it from scope and audience, then state that choice.
- Distinctive: line 56
Call out missing information, unresolved assumptions, or governance gaps explicitly.
- Very specific: line 61
Use shall for mandatory requirements and should for recommendations.
- Distinctive: line 64
Keep business rationale separate from technical design and operational procedure.
- Distinctive: line 65
Prefer tables, IDs, checklists, and clear headings over long narrative blocks when they improve execution clarity.
- Distinctive: line 85
When surfacing review findings, classify each issue so readers know what to fix first:
- Distinctive: line 98
When rewriting or reviewing:
- Distinctive: line 102
keep edits implementation-ready rather than academic
- Distinctive: line 103
use the most appropriate structure for the artifact instead of forcing one generic template
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Document Writer Reviewer
Use this skill to turn raw notes, uneven drafts, or weakly governed delivery documents into cleaner artifacts that teams can review, approve, and execute against.
Core Goal
Produce documentation that is:
- structurally coherent
- explicit about scope, ownership, and status
- traceable across business, functional, technical, testing, architectural, and operational layers
- precise enough to guide implementation or governance review
Artifact Router
Choose the review lens based on the document type:
- BRD: Business value, scope boundaries, objectives, success measures, stakeholders
- PRD: Product vision, personas, user stories, prioritized features, success metrics
- FSD / FRD: User behaviors, flows, edge cases, functional requirements, acceptance criteria
- NFR: Measurable performance, availability, security, scalability, compliance, and DR targets with verification methods
- TRD / SRS: Technical constraints, interfaces, environments, verification methods, traceable requirement statements
- ADR: Context, options, decision, status, and consequences
- SAD / Blueprint: System structure, NFR coverage, integration, data, security, infrastructure, rollout
- Epic / Story / Task: Traceability to a SAD component and requirement, acceptance criteria, Definition of Ready/Done, right-sized scope (INVEST)
- Runbook / Postmortem: Executable procedures, alert-to-action mapping, escalation paths, blameless root cause, owned action items
- Developer Handoff: Design assets, tokens, states, implementation notes, QA checks
If the artifact type is unclear, infer it from scope and audience, then state that choice.
Review Workflow
- Identify the artifact type, audience, and intended use.
- Preserve the original intent, but remove ambiguity, redundancy, and structural drift.
- Normalize the document into a clear section hierarchy with document control where needed.
- Tighten language so requirements and decisions are testable, traceable, and attributable.
- Call out missing information, unresolved assumptions, or governance gaps explicitly.
- Mark content you add beyond the supplied material as [Recommended Enhancement].
Writing Rules
- Use
shallfor mandatory requirements andshouldfor recommendations. - Replace vague language such as
fast,secure,robust, oruser-friendlywith measurable criteria or named standards. - Keep business rationale separate from technical design and operational procedure.
- Prefer tables, IDs, checklists, and clear headings over long narrative blocks when they improve execution clarity.
- Preserve traceability between related artifacts when IDs or links already exist.
- Execute every runnable command a document embeds before delivery, or mark it explicitly
TODO-VERIFY: unexecuted— a copied "verify with:" command is a claim, not a fact, and its embedded commands are part of the document's testable surface. When the same command appears in multiple files, flag the duplication as a maintenance risk.
Shared Quality Checks
Review every document for these cross-cutting concerns:
- Governance: version, status, ownership, approval path, auditability
- Traceability: business need to requirement to design to test where applicable
- Precision: one requirement or decision per statement where possible
- Actionability: implementation, validation, or approval steps are clear
- Completeness: assumptions, dependencies, risks, and exceptions are not hidden
Issue Severity Classification
When surfacing review findings, classify each issue so readers know what to fix first:
| Severity | Label | Definition | Example |
| Critical | [CRITICAL] | Blocks approval or creates compliance/legal risk | No approval path, undefined scope, regulation missed |
| Major | [MAJOR] | Significant gap that will cause rework or ambiguity in delivery | Missing acceptance criteria, orphan requirement, untraceable decision |
| Minor | [MINOR] | Structural or clarity issue that reduces quality but is fixable quickly | Vague wording, inconsistent terminology, missing ID |
| Enhancement | [Recommended Enhancement] | Content added beyond original material that would improve the document | Missing risk section, suggested success metric |
Surface Critical and Major issues before Minor ones. Never bury blockers in a list of nits.
Output Expectations
When rewriting or reviewing:
- identify the document type
- surface the highest-risk gaps first using severity labels
- keep edits implementation-ready rather than academic
- use the most appropriate structure for the artifact instead of forcing one generic template
Anti-pattern quick reference
| Anti-pattern | Instead |
Vague language (fast, secure, robust, user-friendly) | Measurable criteria or named standards |
| Multiple requirements or decisions packed into one statement | One requirement or decision per statement |
| Business rationale mixed into technical design or operational procedure | Keep the three layers separate |
| Long narrative blocks where execution clarity matters | Tables, IDs, checklists, and clear headings |
| Blockers buried in a list of nits | Surface Critical and Major issues before Minor ones |
| Silently adding content beyond the supplied material | Mark additions as [Recommended Enhancement] |
| Forcing one generic template onto every artifact | Use the most appropriate structure for the artifact type |
| Rewriting away the original intent | Preserve intent; remove only ambiguity, redundancy, and structural drift |
| Leaving the artifact type ambiguous | Infer it from scope and audience, then state that choice |
| Hiding assumptions, dependencies, or risks | Call out missing information and governance gaps explicitly |
| Delivering a doc with unexecuted embedded commands | Run each runnable command during authoring, or mark it TODO-VERIFY: unexecuted |
Pre-flight checklist — run before delivering any document review
- Scope, audience, and document purpose are explicit
- Terminology is consistent and undefined acronyms are resolved
- Requirements or decisions are atomic and testable where applicable
- Ownership, status, and approval expectations are clear
- Missing dependencies, assumptions, or risks are called out directly
- The document is suitable for repository
docs/storage or formal review - Every embedded runnable command was executed during authoring or carries an explicit
TODO-VERIFYmarker
In this repository91 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- goSkill
- json-standardsSkill
- pythonSkill
- rabbitmqSkill
- rSkill
- rustSkill
- code-standardsSkill
- software-architectureSkill
- swiftSkill
- typescript-code-standardsSkill
- architecture-documentation-and-decision-recordsSkill
- business-requirements-standardsSkill
- developer-handoff-standardsSkill
- development-planning-standardsSkill
- feature-planning-standardsSkill
- functional-specification-standardsSkill
- non-functional-requirements-standardsSkill
- operations-standardsSkill
- product-requirements-standardsSkill
- documentationSkill
- solution-architecture-standardsSkill
- technical-requirements-standardsSkill
- documenting-codeSkill
- github-circleci-standardsSkill
- graphifySkill
- puml-diagramsSkill
- software-architecture-progressionSkill
- testingSkill
- software-test-specificationSkill
- zeno-councilSkill
- zeno-debugSkill
- zeno-insightSkill
- zenoSkill
- zeno-stackSkill
- zeno-accessibilitySkill
- zeno-angular-developerSkill
- zeno-api-designSkill
- zeno-browser-qaSkill
- zeno-build-resolverSkill
- zeno-codebase-onboardingSkill
- zeno-code-tourSkill
- zeno-comment-analysisSkill
- zeno-config-gcSkill
- zeno-context-budgetSkill
- zeno-context-compactionSkill
- zeno-cost-reportSkill
- zeno-database-migrationsSkill
- zeno-deep-researchSkill
- zeno-deployment-patternsSkill
- zeno-design-systemSkill
- zeno-docker-patternsSkill
- zeno-e2e-testingSkill
- zeno-error-handlingSkill
- zeno-find-skillsSkill
- zeno-frontend-designSkill
- zeno-github-opsSkill
- zeno-git-workflowSkill
- zeno-harness-optimizerSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

