technical-writer

Developer documentation following the Diataxis framework organizes content into tutorials, how-to guides, reference material, and explanations. This Skill structures your API docs and READMEs using these four categories to ensure clarity and precision for the developer audience.

The best way to generate a README is by applying technical writing best practices for structure and empathy. This Skill creates comprehensive README files that clearly explain your project's purpose, setup, and usage to improve the developer experience.

Creating an Architecture Decision Record (ADR) involves documenting the context, decision, and consequences of a technical choice. This Skill assists in writing structured ADRs to capture your architectural decisions clearly for your engineering team.

Yes, you can use this Skill to generate structured API documentation for endpoints and functions. It produces structured reference entries that adhere to developer documentation standards, ensuring your API reference material is precise and easy to navigate.

You need to write tutorials for learning-oriented developer onboarding and how-to guides for task-oriented problem solving. This Skill applies the Diataxis framework to differentiate the two, ensuring your developer documentation serves the correct learning purpose.

AI technical writing limitations include lacking deep project-specific context and requiring human review for architectural accuracy. This Skill provides structured drafts for ADRs and API docs, but you must verify the technical precision against your actual codebase.