docs-writer

Inspect source code and update MDX documentation to fix gaps.

9|11|Updated May 7, 2025
One-click install
npx skills add https://github.com/lancedb/docs --skill docs-writer-lancedb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/lancedb/docs/tree/main/workflows/docs-audit/skills/docs-writer
Command: npx skills add https://github.com/lancedb/docs --skill docs-writer-lancedb

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps technical writers automatically identify and fix gaps and inconsistencies in documentation, ensuring accurate information across pages.

Core Features & Use Cases

  • Gap Detection: Analyze reports from docs-audit runs to locate documentation inaccuracies.
  • Code Inspection: Verify source code correctness, parameters, and behaviors referenced in the documentation.
  • Update & Validate: Edit MDX pages to fix gaps, with verification of code snippets and references.
  • Use Case: For example, if a parameter name changed in source code but the docs still mention the old name, this Skill updates the documentation to reflect the latest codebase.

Quick Start

Use the docs-writer skill to analyze the latest audit report and automatically update affected documentation pages.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I automatically identify and fix documentation gaps in MDX files?

Automatically identifying and fixing documentation gaps in MDX files requires inspecting the relevant source code repositories to verify parameters and behaviors, then directly editing the MDX pages to correct any inconsistencies and ensure technical accuracy.

What is the best way to keep API documentation accurate after a codebase change?

Keeping API documentation accurate after a codebase change involves inspecting the updated source code to detect parameter or behavioral shifts, then applying those updates directly to your technical MDX pages to resolve any existing gaps.

How does source code inspection work for updating technical documentation?

Source code inspection for updating technical documentation works by analyzing audit reports to locate inaccuracies, verifying the correctness of parameters and behaviors in the repository, and modifying the MDX pages to match the actual codebase implementation.

Can I update outdated parameter names in MDX documentation by checking the source repository?

Yes, you can update outdated parameter names in MDX documentation by verifying the current names against the source repository code, then editing the affected MDX files directly to ensure the documentation reflects the latest codebase changes.

Do I need an audit report to start fixing inconsistencies in technical MDX pages?

An audit report is typically needed to start fixing inconsistencies in technical MDX pages, as it analyzes previous runs to locate documentation inaccuracies and pinpoint exactly where source code inspection and subsequent MDX updates are required.