skills.rest
imMamdouhaboammar
imMamdouhaboammarCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

agency-technical-writer

Writes developer documentation including README files, API references, and tutorials.

Updated Jul 27, 2026
Search Tags:#documentation#openapi#technical writing#readme#tutorials#api reference#docusaurus
One-click install
npx skills add https://github.com/imMamdouhaboammar/Mimera --skill agency-technical-writer-immamdouhaboammar
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: agency-technical-writer
Source: https://github.com/imMamdouhaboammar/Mimera/tree/main/.agents/skills/engineering-technical-writer
Command: npx skills add https://github.com/imMamdouhaboammar/Mimera --skill agency-technical-writer-immamdouhaboammar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineering teams ship code without documentation, leaving developers confused, support tickets piling up, and adoption stalling. This Skill turns complex engineering concepts into clear, accurate developer documentation that reduces support burden and accelerates onboarding. ## Core Features & Use Cases - README & Tutorial Authoring: Produces README files that pass the 5-second test and step-by-step tutorials that get developers from zero to working in under 15 minutes. - API Reference Documentation: Creates OpenAPI/Swagger-based API references with working code examples, error documentation, and migration guides. - Docs-as-Code Infrastructure: Sets up documentation pipelines with Docusaurus, MkDocs, Sphinx, or VitePress, integrated into CI/CD so outdated docs fail the build. - Use Case: Your team just shipped a new REST API but developers keep filing issues asking how authentication works. Use this Skill to generate a complete API reference with authentication guides, rate-limit documentation, and tested code examples for every endpoint. ## Quick Start Ask the agent to write a README and getting-started tutorial for your project, providing your package name, installation command, and a basic usage example.

Frequently Asked Questions about agency-technical-writer

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

FAQPage Schema
How do I write a good README for my open source project?▼

A good README answers three questions in five seconds: what is this, why should I care, and how do I start. Lead with a one-sentence description, show the shortest working quick-start example, then cover installation, configuration, and usage in separate sections.

How to generate API documentation from OpenAPI specs?▼

Write an OpenAPI 3.x spec describing endpoints, request bodies, responses, and error codes with examples, then render it with tools like Redoc or Stoplight. Include authentication, rate limiting, and pagination details in every reference entry.

What is the difference between tutorials, how-to guides, and reference docs?▼

The Divio system separates docs by purpose: tutorials teach beginners through guided projects, how-to guides solve specific tasks, reference docs provide complete factual information, and explanation docs clarify concepts. Mixing these types in one document reduces clarity.

Which documentation site generator should I use: Docusaurus, MkDocs, or VitePress?▼

Docusaurus suits versioned product docs with versioning and search plugins built in. MkDocs fits Python projects with simple Markdown workflows, while VitePress works well for Vue-based projects needing fast builds. All three integrate into CI/CD pipelines.

How do I keep documentation from going stale as code changes?▼

Ship docs in the same pull request as the feature or API change, and integrate docs builds into CI so broken examples fail the build. Set recurring review cycles for time-sensitive content and track accuracy with a content audit spreadsheet.

Related Skills

Explore More Content & Communication Skills→
FriendlyInternetFriendlyInternet
10

housekeeping

Generate weekly repository housekeeping reports identifying stale branches, mislabeled issues, stuck tickets, and idle PRs.

Official
Advanced
musher-devmusher-dev

auditing-docs-metrics

Audit developer documentation effectiveness by computing KPIs like Time to First Success.

Official
Advanced
HermeticOrmusHermeticOrmus

Doc Testing Patterns

Test technical documentation with doctest, Vale, and link checking.

Community
Advanced
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate