mb-tech-writer

Create code documentation from source analysis and existing markdown.

Updated Apr 6, 2026
One-click install
npx skills add https://github.com/Yanick-mj/mb-framework --skill mb-tech-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mb-tech-writer
Source: https://github.com/Yanick-mj/mb-framework/tree/main/agents/tech-writer
Command: npx skills add https://github.com/Yanick-mj/mb-framework --skill mb-tech-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates stale or missing documentation by automatically producing clear, accurate technical guides directly from the codebase, saving developers time and reducing knowledge gaps.

Core Features & Use Cases

  • Read source files to understand code that needs documentation.
  • Search existing docs and update them instead of creating duplicates.
  • Edit and write markdown files with evidence (file paths and excerpts) to ensure accuracy.
  • Enforce strict rules such as never inventing signatures and always providing evidence.
  • Use case: After adding a new API endpoint, the skill scans the implementation, finds related docs, updates them with the new parameters, and creates any missing reference pages.

Quick Start

Ask the tech writer skill to create documentation for the new API endpoint GET /users aimed at frontend developers.

Frequently Asked Questions about mb-tech-writer

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

FAQPage Schema
How do I generate technical documentation from source code automatically?

To generate technical documentation from source code automatically, you need a tool that reads source files, analyzes the implementation, and writes new markdown files. This process extracts code signatures and logic to produce accurate technical guides without manual writing.

How do I update existing markdown files without creating duplicate documentation?

To update existing markdown files without duplicates, the documentation process searches current markdown content for related sections, edits them directly, and applies strict rules to ensure accuracy. This prevents duplicate API docs by modifying existing pages instead of creating new ones.

Can I generate API docs for frontend developers after adding a new endpoint?

Yes, you can generate API docs for frontend developers after adding a new endpoint. The documentation process scans the new implementation, identifies new parameters, finds related docs, and creates missing reference pages aimed at specific audiences like frontend developers.

What is the best way to ensure generated code documentation provides accurate evidence?

The best way to ensure generated code documentation provides accurate evidence is to use a process that enforces strict rules against inventing signatures. It extracts direct evidence like file paths and code excerpts from source files to verify every documented technical detail.

Does automated technical writing work for updating stale documentation?

Yes, automated technical writing works for updating stale documentation by reading current source files and using them as references. It eliminates stale or missing documentation by producing updated technical guides directly from the codebase, reducing knowledge gaps.