skills.rest
patrickserrano
patrickserranoCOMMUNITY
Explore all skills by this author →
Website𝕏@patrickgserranoGitHub

project-documentation

Write briefs, PRDs, PCDs, and implementation plans following a dated docs taxonomy.

3|Updated Jun 15, 2026
Search Tags:#documentation#markdown#implementation plan#prd#doc comments#brief#docs taxonomy
One-click install
npx skills add https://github.com/patrickserrano/lacquer --skill project-documentation-patrickserrano
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-documentation
Source: https://github.com/patrickserrano/lacquer/tree/main/core/skills/project-documentation
Command: npx skills add https://github.com/patrickserrano/lacquer --skill project-documentation-patrickserrano

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Projects accumulate documentation inconsistently: briefs get lost, requirements and design docs mix together, and doc-comment baselines quietly erode when CI checks are removed. This Skill standardizes how project documentation is written, organized, and maintained so every artifact stays auditable and doc comments keep building clean. ## Core Features & Use Cases - Docs Taxonomy: Derives a PRD from the brief at docs/brief.md, then a PCD, then an implementation plan, each stored as a dated YYYY-MM-DD-<feature>-<type>.md file under docs/prds/, docs/pcds/, or docs/plans/. - Documentation Baseline Guidance: Enforces the rule that every declaration above private carries a doc comment and the docs build resolves, with per-stack toolchains (SwiftLint missing_docs, TypeDoc validation, deno doc --lint). - Docs Publisher Retirement: Explains how to safely fix documentation checks or retire unshipped docs publishing scripts by grepping for live callers before deleting anything. - Use Case: When starting a new feature, ask the AI to draft the PRD from your brief, then generate the PCD and a bite-sized implementation plan, each in its correctly named dated file. ## Quick Start Write a PRD for the new onboarding feature derived from docs/brief.md and save it as a dated file in docs/prds/.

Frequently Asked Questions about project-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure PRD and design docs in a project?▼

Start from a brief at docs/brief.md, then derive a PRD in docs/prds/, a PCD in docs/pcds/, and an implementation plan in docs/plans/. Name each file YYYY-MM-DD-<feature>-<type>.md so history stays auditable.

How to write a product requirements document from a project brief?▼

Derive the PRD directly from the brief, capturing the what and why of the feature. Store it as a dated file in docs/prds/, then derive the PCD covering the how, and finally a plan of bite-sized implementation tasks.

Which tools check doc comments for Swift, TypeScript, and Deno?▼

Swift uses SwiftLint missing_docs for comment presence only, TypeScript uses TypeDoc validation.notDocumented plus invalidLink, and Deno uses deno doc --lint. Only web and Supabase currently verify that docs builds resolve from the local hook.

Can I safely delete an unshipped docs publishing script?▼

Not automatically. Unshipped means the lacquer stopped managing the file, not that nothing calls it. Grep for the script's path and basename first, since CI workflows or pre-commit hooks may still reference it and deleting it would break working pipelines.

What happens when a documentation baseline relaxation expires?▼

An expired relaxation is a hard failure. Relaxations live in .lacquer.toml under [baseline.relax] with a required until date and reason, and checks keep running and reporting while relaxed so the debt stays visible.

Related Skills

Explore More Product & Management Skills→
rusirusi
3

jr-init

Initialize project direction with a contract-style workflow defining mission, roadmap, and technical foundation.

Community
Advanced
Ab0umarAb0umar

writing-plans

Converts specs into detailed multi-step implementation plans with bite-sized TDD tasks.

Community
Intermediate
nmnmccnmnmcc
2

docs

Update software documentation and code comments to match current code behavior.

Community
Advanced
zoraxlzoraxl
3

wiki-runbook

Standardize operational runbooks and infrastructure documentation across wiki namespace zones.

Community
Intermediate