Apply writing standards to READMEs, API docs, changelogs, and code comments.
npx skills add https://github.com/PedroSantiagoDev/buildup --skill writing
Please help me install this Agent Skill. Skill: writing Source: https://github.com/PedroSantiagoDev/buildup/tree/main/.claude/skills/writing Command: npx skills add https://github.com/PedroSantiagoDev/buildup --skill writing
This Skill provides comprehensive guidelines for clear, concise, and effective technical writing, ensuring all documentation, comments, and communications are easy to understand. It reduces ambiguity, improves team collaboration, and saves time spent clarifying poorly written content.
Using the writing skill, draft a concise commit message for a change that fixed a payment validation error, ensuring it follows the imperative mood and is specific.
High-intent search queries and answers about installing and using this skill.
Clear technical documentation uses active voice, leads with results, places one idea per sentence, and eliminates redundancy. Structure READMEs and API docs with imperative headings, explain the *why* in code comments rather than the *what*, and keep sentences short and scannable to reduce onboarding friction.
Effective commit messages use imperative mood, stay specific about the change, and explain the rationale. PR descriptions should lead with results, state what changed and why, use active voice, and maintain one idea per sentence to help reviewers understand context without ambiguity.
Code comments should explain *why* a decision was made, not restate the code itself. Error messages follow the pattern: what happened, then what to do. Both use concise language, avoid vague terms, maintain professional tone, and structure information so developers can act immediately.
READMEs and API docs should lead with results, use descriptive naming, employ active voice throughout, and structure content for scannability. Follow consistent formatting, eliminate redundancy, use imperative language for instructions, and ensure brevity so new users grasp purpose and usage without friction.
Ambiguous or verbose documentation forces clarification conversations, wastes review time, and slows onboarding. Concise, active-voice writing with one idea per sentence eliminates misinterpretation, makes intent obvious on first read, and reduces the time spent explaining poorly written content across commits, comments, and documentation.
Yes. These principles—active voice, conciseness, one idea per sentence, descriptive naming, and clear structure—apply uniformly across READMEs, API docs, changelogs, commit messages, PR descriptions, and code comments, ensuring consistency and scannability across all technical communication formats.
rpoole-devStructures and drafts a sell-side Confidential Information Memorandum for M&A processes.
micaelmaltaStandardize Git commit messages using Conventional Commits rules.
ekremmkasapEnforce Python code style with ruff, mypy, and Google-style docstrings.
kirvinGuide writing style and tone for content types with persona selection.
