← Back to list
writing
by whyleonardo
Reusable Claude Code configuration template with custom commands and skills
⭐ 0🍴 0📅 Jan 13, 2026
Run in ManusSKILL.md
name: writing description: Guidelines for clear technical writing and documentation.
Technical Writing Standards
General Principles
- Be concise - every word should earn its place
- Write for your audience (developer, user, stakeholder)
- Use active voice over passive voice
- Front-load important information
- One idea per paragraph
Documentation Structure
- Start with a brief summary/overview
- Use headers to create scannable structure
- Include practical examples
- End with next steps or related resources
- Keep docs close to the code they describe
Code Comments
- Explain "why", not "what"
- Comment on non-obvious decisions
- Keep comments up-to-date with code
- Use TODO/FIXME with context and ticket numbers
- Avoid commented-out code (use version control)
Commit Messages
Format:
<type>(<scope>): <subject>
<body>
Types: feat, fix, docs, style, refactor, test, chore
- Subject: imperative mood, max 50 chars, no period
- Body: wrap at 72 chars, explain what and why
PR Descriptions
- Summarize the change in 1-2 sentences
- List what changed and why
- Include testing instructions
- Link to related issues/tickets
- Add screenshots for UI changes
README Structure
- Project name and brief description
- Quick start / Installation
- Usage examples
- Configuration options
- Contributing guidelines
- License
API Documentation
- Document all public endpoints/methods
- Include request/response examples
- Specify required vs optional parameters
- Document error responses
- Keep examples up-to-date and tested
Score
Total Score
55/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon
