docs-writer

Document Next.js and Convex code with per-file summaries and data flows.

Updated Dec 13, 2025
One-click install
npx skills add https://github.com/Posteriot/makalah-app --skill docs-writer-posteriot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/Posteriot/makalah-app/tree/main/.codex/skills/project/docs-writer
Command: npx skills add https://github.com/Posteriot/makalah-app --skill docs-writer-posteriot

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that every documentation request is grounded in the actual codebase by delivering a high-level explanation backed by file-specific insights, so teams avoid vague assumptions and get precise implementation context.

Core Features & Use Cases

  • Structured Summary: Produces a concise overview of the requested area and highlights the intended strategy for linking features or components across the codebase.
  • Detailed File Walkthroughs: Covers each relevant file with notes on purpose, data flow, dependencies, and edge cases while keeping the language bilingual per the provided style guide.
  • Use Case: When a developer or writer needs to explain how a specific Next.js page or Convex endpoint works, including data hooks, props, and related files, this Skill maps the files before crafting the documentation.

Quick Start

Request a documentation summary covering the target files and their data flows to activate this Skill.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I document Next.js code structure with file-specific explanations?

You document Next.js code structure by mapping dependencies, noting data flows, and listing related files to produce a high-level summary backed by per-file walkthroughs. This grounds the documentation in the actual codebase, avoiding vague assumptions.

What's the best way to write technical documentation for Convex endpoints?

Writing technical documentation for Convex endpoints involves reading the actual source files and mapping data hooks before crafting explanations. This delivers precise implementation context by covering purpose, data flow, dependencies, and edge cases for both high-level and detailed consumers.

Can I generate per-file implementation details for my codebase?

Yes, you can generate per-file implementation details by reading source files and applying a provided style template. The process maps dependencies and notes edge cases, ensuring the walkthroughs maintain concise clarity for detailed consumers.

Does this approach work for documenting both high-level features and detailed code flows?

Documenting both high-level features and detailed code flows works by producing a structured overview alongside file-specific insights. The method highlights the intended strategy for linking components and covers data hooks, props, and related files according to style templates.

Why do I need to map dependencies before writing codebase documentation?

Mapping dependencies before writing codebase documentation is necessary to ground explanations in actual implementation details. This ensures summaries and per-file walkthroughs accurately reflect data flows, edge cases, and related files instead of relying on vague assumptions.