technical-writer

Name: technical-writer
Availability: InStock
Author: buiphucminhtam

Generate developer-facing documentation from codebase artifacts.

47|11|Updated Mar 6, 2026

Search Tags:#changelog #architecture #documentation #api-reference #technical-writing #developer-guides

Ready to run

npx skills add https://github.com/buiphucminhtam/forgewright --skill technical-writer-buiphucminhtam

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/buiphucminhtam/forgewright/tree/main/skills/technical-writer
Command: npx skills add https://github.com/buiphucminhtam/forgewright --skill technical-writer-buiphucminhtam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly generate consistent, high-quality documentation from codebases, reducing manual writing effort and ensuring standardization across projects.

Core Features & Use Cases

Generates API references, developer guides, READMEs, architecture overviews, and changelogs directly from artifacts.
Uses Conventional Commits for automated changelog generation.
Supports production-grade orchestration with strict frontmatter validation and optional resources (scripts, references, assets) to augment docs.
Aids onboarding and API consumption by providing ready-to-use documentation packages.

Quick Start

Provide a codebase context and command the skill to generate comprehensive project documentation.

Frequently Asked Questions about technical-writer

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

FAQPage Schema

How do I generate API references and developer guides from a codebase?▼

Generate comprehensive API references and developer guides by providing a codebase context and commanding the skill to convert project artifacts into ready-to-use documentation.

Can I automate changelog generation using Conventional Commits?▼

Automate changelog generation by applying Conventional Commits; the skill parses commit messages to produce structured, developer-facing changelog entries for your software projects.

What is the best way to create architecture overviews and READMEs from existing code?▼

Create architecture overviews and READMEs by processing codebase artifacts through strict YAML frontmatter validation, yielding standardized, production-grade project documentation.

Does this documentation generation approach support adding custom scripts and reference assets?▼

Yes, the documentation generation process exposes optional resources including custom scripts, references, and assets to augment and enhance the generated developer-facing documentation.

Are there limitations when enforcing metadata structure in generated technical documentation?▼

Enforcing metadata structure requires strict YAML frontmatter in SKILL.md and a valid skill entry point; documentation generation fails if these structural validation requirements are unmet.