tech-writer

Generate audience-specific documentation synced with the codebase.

Updated Aug 23, 2026

Search Tags:#architecture #documentation #technical-writing #api-docs #keep-a-changelog #developer-docs

Ready to run

npx skills add https://github.com/phishkatlabs/phishkat-crew --skill tech-writer-phishkatlabs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: tech-writer
Source: https://github.com/phishkatlabs/phishkat-crew/tree/main/tech-writer
Command: npx skills add https://github.com/phishkatlabs/phishkat-crew --skill tech-writer-phishkatlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the codebase and fails to meet the needs of multiple audiences. Tech-writer ensures consistency by producing audience-specific documentation that remains the single source of truth and is easy to maintain.

Core Features & Use Cases

Audience-specific doc sets: READMEs for first-time users, API docs for integrators, and architecture docs for maintainers.
DRY references: centralized source of truth with cross-references to code artifacts to prevent drift.
Quality and maintainability: copy-pasteable commands, accurate examples, and Keep a Changelog-compliant release notes documentation.

Quick Start

Generate README, API.md, ARCHITECTURE.md, and CHANGELOG.md for a project and commit the changes to the repository.

Frequently Asked Questions about tech-writer

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

FAQPage Schema

How do I generate developer documentation that stays in sync with my codebase?▼

To generate developer documentation that stays in sync with your codebase, use a tool that cross-references code artifacts directly. This approach validates content against the repository to prevent drift and produce audience-specific docs.

What is the best way to structure technical documentation for multiple audiences?▼

The best way to structure technical documentation for multiple audiences is to enforce a three-audience split: READMEs for users, API docs for integrators, and ARCHITECTURE docs for maintainers, ensuring each group gets relevant content.

How do I write release notes that follow the Keep a Changelog standard?▼

To write release notes that follow the Keep a Changelog standard, you need a workflow that enforces compliance while documenting changes. This ensures your CHANGELOG.md maintains a consistent, machine-readable format for all releases.

Does this approach to API docs support copy-pasteable commands for integrators?▼

Yes, this approach to API docs supports copy-pasteable commands for integrators. By validating against the actual repository, it ensures all examples and commands are accurate, centralized, and ready for immediate integration use.

Why does my project's architecture documentation drift from the actual code?▼

Architecture documentation drifts from the actual code when it lacks centralized cross-references to code artifacts. Without a single source of truth validating content against the repository, manual updates inevitably fall behind codebase changes.