Documentation Writer

Name: Documentation Writer
Availability: InStock
Author: zjuxjy

Provide guidelines for writing code comments, README files, commit messages, and ADRs.

Updated Feb 27, 2026

Search Tags:#documentation #writing #commit messages #adr #readme #code comments

Ready to run

npx skills add https://github.com/ZJUxjy/opencode_lite --skill documentation-writer-zjuxjy

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Documentation Writer
Source: https://github.com/ZJUxjy/opencode_lite/tree/main/skills/documentation
Command: npx skills add https://github.com/ZJUxjy/opencode_lite --skill documentation-writer-zjuxjy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidelines and best practices for creating high-quality documentation across various formats, ensuring clarity, consistency, and maintainability in technical projects.

Core Features & Use Cases

Code Comments: Guidance on when and how to write effective code comments, including JSDoc/TSDoc examples.
README Files: A standard structure and content recommendations for project READMEs.
Commit Messages: Best practices for writing clear and informative Git commit messages using conventional commits.
ADRs: Instructions for documenting architectural decisions.
Use Case: A new developer joins a project and needs to understand how to document their code and contributions effectively, ensuring consistency with existing standards.

Quick Start

Follow the guidelines in this skill to write clear documentation for your code.

Frequently Asked Questions about Documentation Writer

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

FAQPage Schema

How do I write clear and maintainable documentation for my code?▼

To write clear documentation, follow standardized guidelines for code comments, README files, commit messages, and ADRs, ensuring project onboarding and technical decisions are logged with consistency and high quality.

What is the best way to structure a project README file?▼

The best way to structure a project README file is to follow a standard structure and content recommendations that ensure clarity, maintainability, and effective project onboarding for new developers joining the project.

How do I write effective code comments using JSDoc or TSDoc?▼

Writing effective code comments using JSDoc or TSDoc involves following specific guidelines on when and how to document code clarity, ensuring your technical documentation remains maintainable across different formats.

How do I write clear Git commit messages?▼

To write clear Git commit messages, apply conventional commits best practices that ensure your version control history remains informative, readable, and consistent with project documentation standards.

When do I need to write an Architecture Decision Record?▼

You need to write an Architecture Decision Record (ADR) when you want to document architectural decisions, providing a clear log of technical choices to ensure maintainability and project onboarding for new developers.

Does this documentation writing guideline work for new developers joining a project?▼

Yes, these documentation guidelines are designed for new developers joining a project, helping them understand how to document code and contributions effectively while ensuring consistency with existing standards.