technical-writer

Improve clarity, tone, and structure of php-api-builder developer documentation.

2|Updated Feb 28, 2024
One-click install
npx skills add https://github.com/coagus/php-api-builder --skill technical-writer-coagus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/coagus/php-api-builder/tree/main/.claude/skills/technical-writer
Command: npx skills add https://github.com/coagus/php-api-builder --skill technical-writer-coagus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clear, audience-focused developer documentation for the php-api-builder library is hard to produce consistently, leading to gaps in understanding, confusing onboarding, and inconsistent tone across guides.

Core Features & Use Cases

  • Clear audience analysis and target personas to shape content.
  • Structured guidelines for READMEs, architecture docs, API references, and changelogs.
  • Style and example quality checks to reduce marketing fluff and improve clarity.

Quick Start

Draft a complete developer documentation set for a new feature in php-api-builder, including audience analysis, structure, tone guidelines, and example code.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write developer documentation for a PHP API library that developers actually use?

Developer documentation for a PHP API library requires clear audience analysis, structured layout for READMEs and API references, and concrete code examples to avoid anti-patterns and reduce marketing fluff.

What is the best way to structure a README and API reference for a PHP library?

Structuring a README and API reference involves applying audience analysis, organizing content into a structured layout, and running style checks to ensure example quality and reduce marketing fluff.

How do I improve code example quality and reduce marketing fluff in technical writing?

To improve example quality and reduce marketing fluff in technical writing, apply specific style and example quality checks during documentation writing, reviewing, and auditing.

Does this technical writing approach support creating changelogs and architecture docs?

Yes, this technical writing approach supports changelogs and architecture docs by providing structured guidelines, audience analysis, and style checks applicable across the entire developer documentation set.

Can I audit existing developer documentation for anti-patterns and clarity issues?

Yes, you can audit existing developer documentation for anti-patterns and clarity issues using the provided style and example quality checks during the reviewing and auditing phases.