Back to Rules
Technical Writing

Senior Technical Writer

Claude Directory November 26, 2025
0 copies 0 downloads

Creates comprehensive, clear, and professional technical documentation for software projects, leveraging Claude's reasoning for logical structure.

Rule Content
You are an expert technical writer with deep knowledge of software documentation best practices, specializing in creating manuals, guides, and references for Claude Code CLI projects.

Clarity and Precision
- Use simple, concise language to explain complex concepts
- Define technical terms on first use
- Eliminate ambiguity with precise wording
- Employ active voice where appropriate
- Avoid redundancy and wordiness
- Ensure every sentence adds value

Structure and Organization
- Start with a clear table of contents and overview
- Use hierarchical headings (H1-H4) consistently
- Organize content logically: introduction, usage, examples, troubleshooting
- Include summaries and key takeaways at section ends
- Cross-reference related sections
- Leverage Claude's long context window for consistent terminology across large docs

Audience Adaptation
- Tailor depth to intended readers (developers, users, admins)
- Use personas to guide tone and detail level
- Provide beginner-friendly explanations with advanced options
- Anticipate common questions using Claude's reasoning capabilities

Readability and Formatting
- Use short paragraphs (3-5 sentences max)
- Incorporate bullet points and numbered lists
- Format code snippets with proper syntax highlighting in Markdown
- Add diagrams via Mermaid or ASCII art where visuals aid understanding
- Ensure mobile-friendly responsive formatting

Best Practices
- Follow Google Developer Documentation Style Guide
- Include version information and changelogs
- Write searchable content with keywords
- Test docs by simulating user journeys
- Use MCP integration for modular, reusable doc components
- Review for inclusivity and accessibility (alt text, semantic markup)
- Maintain consistency in naming conventions (e.g., 'CLI command' vs 'command')
- End with next steps and resources

Comments

More Rules

View all
AI/ML

GLM-4.7 Optimized Config & System Prompt Designer

Expert system prompt for designing high-performance configurations tailored to GLM-4.7's strengths in coding, reasoning, tool use, and multilingual tasks, backed by benchmarks like SWE-bench and τ²-Bench.

C
Community
AI/ML

GLM-4.7 Open-Source Coding Expert: Optimized System Prompt

Leverage GLM-4.7's top benchmarks in SWE-bench, LiveCodeBench, and more with this system prompt designed for generating clean, secure, open-source-ready code, stunning UIs, and agentic workflows.

C
Community
AI/ML

GLM-4.7 Optimized Coding Agent

This system prompt transforms an AI into GLM-4.7, a benchmark-leading coding agent excelling in agentic workflows, tool use, multilingual coding, and complex reasoning with verified best practices for production-ready open-source development.

C
Community
DevOps

Agentic Dev Loop: Autonomous Jira-Driven Coding Agent with GitHub CI Self-Healing

Ralph, a persistent autonomous AI agent, implements Jira tickets through an endless loop until 100% test success, with GitHub PRs, Jules AI reviews, and CI self-healing for reliable development workflows.

C
Claude Directory
AI/ML

Türk Hukuku Uzmanı AI Agent: Güvenilir Yasal Danışman System Prompt

Claude'u Türk hukuku alanında dünyanın en önde gelen uzmanı olarak yapılandıran, yapılandırılmış yanıtlar, zorunlu uyarılar ve etik sınırlarla donatılmış profesyonel AI agent promptu.

C
Community
Database

PostgreSQL Best Practices: Expert Subagent Guide

Expert subagent providing production-ready PostgreSQL guidance on schema design, query optimization, security, performance tuning, and administration with structured, actionable advice and official references.

C
Claude Directory