skills.rest
ouakar
ouakarCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate API references, developer guides, READMEs, and changelogs from code artifacts.

Updated Mar 25, 2026
Search Tags:#changelog#documentation#api-reference#technical-writing#developer-guides#conventional-commits
One-click install
npx skills add https://github.com/ouakar/ubinarys-dental --skill technical-writer-ouakar
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/ouakar/ubinarys-dental/tree/main/skills/forgewright/skills/technical-writer
Command: npx skills add https://github.com/ouakar/ubinarys-dental --skill technical-writer-ouakar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the generation and maintenance of comprehensive documentation derived from code and architecture artifacts, ensuring up-to-date references for developers and API consumers.

Core Features & Use Cases

  • Generate API references, developer guides, READMEs, and architecture overviews from existing artifacts.
  • Produce changelogs from commits using the Conventional Commits format.
  • Route outputs through a production-grade orchestrator for consistent documentation delivery.

Quick Start

Run the documentation workflow against your codebase to produce API references, developer guides, and changelogs.

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 code automatically?▼

To generate API references and developer guides from code, you can run an automated documentation workflow against your codebase. This process extracts architecture artifacts and produces production-grade READMEs and structured references for developer onboarding.

What is the best way to create changelogs from conventional commits?▼

Creating changelogs from conventional commits involves parsing commit messages to extract structured release notes. This approach ensures standardized documentation of changes, features, and fixes across CI/CD workflows for API consumers and developer onboarding.

Can I use an automated documentation workflow for CI/CD pipelines?▼

Yes, you can use an automated documentation workflow within CI/CD pipelines. It routes outputs through a production-grade orchestrator, ensuring consistent delivery of API references, architecture overviews, and developer guides during the deployment lifecycle.

Does the generated documentation include YAML frontmatter for static site generators?▼

Yes, the generated documentation includes YAML frontmatter to satisfy formal structural requirements. This ensures the output API references, architecture overviews, and developer guides are compatible with static site generators and standard documentation hosting platforms.

What types of developer documentation can be generated from existing architecture artifacts?▼

From existing architecture artifacts, you can generate API references, developer guides, READMEs, and architecture overviews. This supports comprehensive developer onboarding and API consumption by maintaining up-to-date formal documentation derived directly from the codebase.

Related Skills

Explore More Content & Communication Skills→
mrleeiomrleeio

conventional-commits

Format git commit messages according to the Conventional Commits standard.

Community
Basic
mintlifymintlify
427

doc-helper

Draft and refine Markdown/MDX documentation within Mintlify-powered sites.

Official
Basic
wredziowredzio

git-commit

Generate git commit messages conforming to the Conventional Commits v1.0.0 specification.

Community
Basic
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced