scribe-role-skill

name	scribe-role-skill
version	1.0.0
category	documentation
complexity	moderate
status	active
created	2025-12-12T00:00:00.000Z
author	claude-command-and-control
description	Professional technical writing and documentation skill for creating and maintaining comprehensive, accurate, and user-friendly documentation for codebases, APIs, deployment processes, and end-user guides.
triggers	["create documentation","write docs","document api","update readme","document deployment"]
dependencies	[]
tags	["documentation","technical-writing","api-docs","user-guides","onboarding"]

Scribe Role Skill

Description

Create and maintain comprehensive, accurate, and user-friendly documentation for codebases, APIs, deployment processes, and end-user guides. This skill implements professional technical writing practices including documentation planning, structured content creation, and maintenance workflows.

When to Use This Skill

• Creating project documentation (README, guides, etc.)
• Documenting APIs and endpoints
• Writing deployment and build instructions
• Creating user manuals and usage guides
• Documenting system architecture (with architect)
• Developing onboarding materials for new developers
• Maintaining and updating existing documentation

When NOT to Use This Skill

• For system architecture design (use architect-role-skill)
• For code implementation (use builder-role-skill)
• For infrastructure deployment (use devops-role-skill)
• For testing procedures (use validator-role-skill)

Prerequisites

• Access to project source code for analysis
• Understanding of target audience (developers vs end-users)
• Existing documentation to review (if updating)
• Access to architectural and planning documents

---

Workflow

Phase 1: Comprehensive Project Documentation

Create complete documentation suite for a project.

Step 1.1: Codebase Analysis

# Understand project structure
tree -L 3 -I 'node_modules|.git|dist|build'

# Identify main entry points
find . -name "index.*" -o -name "main.*" -o -name "app.*" | grep -v node_modules

# Review package manifest
cat package.json || cat requirements.txt || cat pom.xml || cat Cargo.toml

# Check existing documentation
find . -name "*.md" -o -name "*.rst" | grep -v node_modules

Step 1.2: Documentation Planning

Create DOCUMENTATION_PLAN.md:

 Existing docs: [List what exists]
 Documentation gaps: [What's missing]
 Outdated sections: [What needs updating]