skills.rest
michaelschecht
michaelschechtCOMMUNITY
Explore all skills by this author →
GitHub

document-writer

Explore codebases to generate documentation and verify code examples.

1|Updated Mar 22, 2026
Search Tags:#technical writing#API documentation#code documentation#README generation#user guide creation
One-click install
npx skills add https://github.com/michaelschecht/Edge-Radar --skill document-writer-michaelschecht
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-writer
Source: https://github.com/michaelschecht/Edge-Radar/tree/main/.claude/skills/document-writer
Command: npx skills add https://github.com/michaelschecht/Edge-Radar --skill document-writer-michaelschecht

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating accurate, comprehensive, and genuinely useful documentation for complex codebases, streamlining the process for technical writers and developers.

Core Features & Use Cases

  • Technical Writing Expertise: Transforms complex codebases into clear documentation.
  • Codebase Exploration: Ability to explore codebases and create documentation without detailed specs.
  • Documentation Types: Specializes in README files, API docs, architecture docs, and user guides.
  • Quality Assurance: Rigorous verification of code examples and documentation accuracy.
  • Collaboration: Supports transparency and accountability in the documentation process.

Quick Start

Use the document-writer skill to create a comprehensive README for the 'Edge-Radar' project.

Frequently Asked Questions about document-writer

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

FAQPage Schema
How do I generate a README for an existing codebase without writing specs?▼

Codebase exploration allows generating a README without detailed specs by analyzing the project structure and code logic directly. This approach automatically extracts architecture details and API endpoints to construct comprehensive documentation, ensuring accuracy without requiring manual specification writing.

Can I automate API documentation creation directly from my source code?▼

Automating API documentation creation directly from source code is possible by exploring the codebase to identify endpoints and parameters. This method verifies code examples for accuracy and adheres to project-specific conventions, ensuring the generated API docs match the actual implementation.

What is the best way to ensure code examples in technical documentation are accurate?▼

The best way to ensure code examples in technical documentation are accurate is through rigorous verification against the actual codebase. This process validates that the examples function correctly and adhere to the project's specific conventions, maintaining documentation integrity.

Does this technical writing approach work for architecture docs and user guides?▼

This technical writing approach works for architecture docs and user guides by exploring the codebase to understand system structure and functionality. It transforms complex code into clear documentation, supporting various types including README files, API docs, and comprehensive user guides.

Related Skills

Explore More Software Engineering Skills→
OneWave-AIOneWave-AI
245

api-documentation-writer

Generate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.

Official
Basic
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate