Skip to content

Design documents

Install

npx skills add keenskills/skills --skill writing-design-documents   # with the skills CLI (skills.sh), for the agents you pick

Or with this package's own installer:

npx @keenskills/writing-design-documents init            # this project, for the agents it uses
npx @keenskills/writing-design-documents init --global   # Claude Code, every project
npx @keenskills/writing-design-documents doctor          # check Python, python-docx, pymupdf and Word
pip install python-docx pymupdf                          # the Python libraries the skill uses

init finds the agents a project uses (Claude Code, AGENTS.md, Gemini CLI, Cursor, Windsurf, Cline, GitHub Copilot) and installs the skill in each one's format; --agent claude,cursor picks them, --dry-run shows the plan. Claude Code gets the whole skill folder in .claude/skills/writing-design-documents/; the others get the text, and the scripts go in .agents/skills/writing-design-documents/. uninstall removes only what init wrote.

As a Claude Code plugin:

/plugin marketplace add keenskills/skills
/plugin install writing-design-documents@keenskills

Requirements: Python 3.9+ with python-docx (and pymupdf for the PDF page checks). finalize uses Microsoft Word on Windows to refresh the table of contents and export the PDF; on other systems update the table of contents in Word by hand. A copied example finds the scripts by itself; for a plugin install set DOCBUILDER_DIR to the skill's scripts folder. Diagrams come from the companion skill drawing-architecture-diagrams.