skills.rest
Muath2000
Muath2000COMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate READMEs, ADRs, guides, and API references with Markdown standards.

Updated Feb 22, 2026
Search Tags:#documentation#technical writing#adr#readme#developer guide#docs-as-code
One-click install
npx skills add https://github.com/Muath2000/TradeStation --skill technical-writer-muath2000
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/Muath2000/TradeStation/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/Muath2000/TradeStation --skill technical-writer-muath2000

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and management of high-quality technical documentation, ensuring clarity, consistency, and maintainability for software projects.

Core Features & Use Cases

  • Documentation Generation: Creates READMEs, ADRs, guides, and API documentation.
  • Style Enforcement: Adheres to best practices for clarity, conciseness, and actionability.
  • Use Case: When starting a new project, use this Skill to generate a comprehensive documentation structure including README, CONTRIBUTING, and ADR templates, ensuring a strong foundation for project communication.

Quick Start

Use the technical-writer skill to generate a README template for a new service.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate a README and ADR templates for a new software project?▼

To generate technical documentation for a new project, this Skill outputs comprehensive README files and Architecture Decision Records, enforcing documentation-as-code principles and Markdown standards to establish a solid foundation for project communication.

What is documentation-as-code and how does it apply to developer guides?▼

Documentation-as-code treats developer guides and API references like software, applying Markdown standards and OpenAPI specifications to ensure clarity, consistency, and maintainability through automated builds, testing, and deployment pipelines.

Can I create API references and runbooks for SaaS platforms using Markdown standards?▼

Yes, you can create API references and runbooks for SaaS platforms. The Skill enforces OpenAPI specifications and Markdown standards to generate developer portal designs and ensure actionable, consistent documentation outputs.

What is the best way to structure changelogs and technical documentation for automated deployment pipelines?▼

The best way to structure changelogs and technical documentation is by enforcing documentation-as-code principles. This Skill generates structured files compatible with automated builds, testing, and deployment pipelines to ensure maintainability.

Does this technical writing approach support OpenAPI specifications for API documentation?▼

Yes, this technical writing approach fully supports OpenAPI specifications. It generates comprehensive API references and developer guides while enforcing clarity, conciseness, and actionability across all documentation outputs.

Related Skills

Explore More Software Engineering Skills→
joyehuangjoyehuang
3

quiz

Generate interactive quizzes from codebase documentation and session history.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate