How does the Writing skill improve my documentation?

It applies principles of brevity, active voice, and clear hierarchy to transform dense text into professional, scannable documentation that is easy for developers to follow.

When should I use code comments according to this skill?

The skill suggests that comments are often unnecessary if code is clear, but when used, they should explain the business logic 'why' rather than just describing the code's 'what'.

Does it provide templates for Pull Requests?

Yes, it includes a structured PR description format focusing on 'What', 'Why', and 'Testing' to ensure reviewers have all the context they need.

Can this skill help with Git commit messages?

Yes, it enforces an imperative-mood format (Verb + What + Context) to ensure your project history is readable, meaningful, and professional.

Technical Writing & Documentation

Name: Technical Writing & Documentation
Author: ramirlm

byramirlm

0•

Content Management

Enforces clear, concise standards for documentation, commit messages, and technical communication within Claude Code.

The Writing skill provides a robust framework for professional technical communication, ensuring all written output—from READMEs and API docs to code comments—is clear, brief, and actionable. It helps developers maintain high documentation standards by emphasizing active voice, removing redundancy, and structuring content for maximum readability. Whether you are drafting a Pull Request description or documenting a complex algorithm, this skill ensures your writing is professional, scannable, and free of jargon-heavy clutter.

Key Features

01Structured API documentation patterns including parameters and error cases

02Standardized templates for README files and PR descriptions

030 GitHub stars

04Automated enforcement of active voice and concise sentence structures

05Guidelines for meaningful code comments that explain 'why' instead of 'what'

06Best practices for imperative-mood Git commit messages

Use Cases

01Writing clear, informative Pull Request descriptions and commit logs

02Refining technical documentation to be more scannable and accessible

03Generating professional, production-ready README files for repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add ramirlm/ramir-cc-marketplace writing

For use in Claude.ai and ChatGPT

Download Skill