kmp-project-docs-maintainer

Maintains and self-heals consumer-facing documentation for Kotlin Multiplatform projects.

2|Updated Jun 6, 2026

Search Tags:#documentation #markdown #adr #readme #self-healing #kotlin multiplatform #docs hygiene

Ready to run

npx skills add https://github.com/ronjunevaldoz/kmp-agent-skills --skill kmp-project-docs-maintainer-ronjunevaldoz

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: kmp-project-docs-maintainer
Source: https://github.com/ronjunevaldoz/kmp-agent-skills/tree/main/skills/kmp-project-docs-maintainer
Command: npx skills add https://github.com/ronjunevaldoz/kmp-agent-skills --skill kmp-project-docs-maintainer-ronjunevaldoz

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? Project documentation drifts out of sync with code, commands, and folder structure as a Kotlin Multiplatform project evolves, leaving stale READMEs, broken links, and disorganized docs folders that mislead developers. ## Core Features & Use Cases - Docs Drift Repair: Updates README, GETTING_STARTED, INSTALL, RELEASING, and docs/reference pages so they match the actual code, commands, and module layout. - Self-Healing Automation: Ships scripts that auto-rename snake_case files to kebab-case, archive completed tasks, regenerate the docs/README.md sitemap, and sync the docs/tasks.md progress index. - Structured Docs Topology: Enforces a canonical docs/ layout with task lanes, ADR decision records, per-module READMEs, and hygiene limits validated by audit tooling. - Use Case: After renaming a Gradle module and adding a new feature, run the healing scripts to re-sync the sitemap, archive finished task notes, and update every doc that referenced the old module name. ## Quick Start Ask the agent to audit and update the project README and docs folder so they match the current modules, commands, and architecture.

Frequently Asked Questions about kmp-project-docs-maintainer

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

FAQPage Schema

How do I keep project documentation in sync with code changes?▼

Read the live docs and the source files they describe, then update the smallest stale surface while keeping terminology and links consistent. The heal_docs.py script automates sitemap regeneration, kebab-case renaming, and archiving of completed task notes.

How to organize a docs folder for a Kotlin Multiplatform project?▼

Use the default topology: docs/tasks.md for active work, docs/architecture.md for system design, docs/decisions/ for ADRs, docs/reference/ for deep-dives, and docs/bugs/ for active bug threads. Task files follow the NN-slug-status.md naming convention.

Does this skill work on projects other than Kotlin Multiplatform?▼

The docs hygiene rules, topology, and healing scripts are generic Markdown and docs/ folder conventions that work on any project. However, the templates, module README guidance, and related skills are tailored to KMP clean architecture workflows.

What is the difference between heal_docs.py and the audit script?▼

heal_docs.py auto-fixes safe violations like snake_case names, completed task archiving, and sitemap regeneration. The audit script audit_skills_repo.py --docs-hygiene-only only flags violations such as orphaned reference docs, oversized files, and missing task index rows without modifying anything.

When should I not use this documentation skill?▼

Do not use it for consumer release notes, per-skill changelogs, or maintaining the kmp-agent-skills repository's own docs, which route to the docs-maintainer skill instead. It also does not cover implementing product code.