skills.rest
qlawmarq
qlawmarqCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

dev-documentation

Create and update development documentation from implementation and design specifications.

Updated Dec 2, 2025
Search Tags:#developer tools#documentation#knowledge management#technical writing#code documentation
One-click install
npx skills add https://github.com/qlawmarq/dotfiles-common --skill dev-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dev-documentation
Source: https://github.com/qlawmarq/dotfiles-common/tree/main/skills/dev-documentation
Command: npx skills add https://github.com/qlawmarq/dotfiles-common --skill dev-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and updating of technical documentation, ensuring it accurately reflects the current implementation and design, thereby reducing the burden of manual documentation.

Core Features & Use Cases

  • Accurate Documentation: Generates documentation based on actual code and design, avoiding guesswork.
  • Update Existing Docs: Modifies existing documentation to align with recent changes.
  • Use Case: After implementing a new feature, use this skill to automatically generate or update the relevant sections of the project's technical documentation.

Quick Start

Use the dev-documentation skill to create documentation for the new authentication module based on the provided design specifications.

Frequently Asked Questions about dev-documentation

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

FAQPage Schema
How do I generate technical documentation directly from code and design specifications?▼

You can update existing documentation by providing recent implementation changes and design specifications. The skill modifies current technical docs to align with new code, ensuring accuracy without guesswork.

What is the best way to automate API guide creation without guessing implementation details?▼

Automate API guide creation by feeding actual code, logs, and test results into the process. This enforces strict rules against speculation, producing accurate technical writing that reflects the true implementation.

Can I update existing technical docs to align with recent code changes automatically?▼

Yes, you can update existing technical docs by supplying the latest implementation changes. The skill modifies current documentation to align with recent code updates, preventing manual rewriting.

Does the documentation generation process work without official documentation or test results?▼

No, the process relies strictly on official documentation, code, logs, and test results to avoid speculation. Without these source materials, it cannot generate accurate technical writing for software projects.

When should I avoid using automated code documentation tools?▼

Avoid automated code documentation when you lack actual code, logs, or test results. The process enforces strict rules against speculation, so it cannot produce accurate system overviews without concrete implementation sources.

Related Skills

Explore More Software Engineering Skills→
MinhmiceMinhmice

documentation-writer

Generate and update technical documentation from code changes and test results.

Community
Intermediate
Agents4Academia-AIAgents4Academia-AI
9

alphaxiv

Retrieve academic paper metadata, abstracts, and AI overviews from the AlphaXiv API.

Official
Intermediate
Likas07Likas07

technical-writer

Generate developer documentation including READMEs, API references, tutorials, and conceptual guides.

Community
Advanced
jey3dayojey3dayo
6

markdown-docs

Review Markdown documentation for clarity, structure, and technical accuracy.

Community
Intermediate