documenter

Name: documenter
Availability: InStock
Author: stonek79

Update README, ARCHITECTURE.md, and JSDoc for public functions.

Updated Jan 17, 2026

Search Tags:#architecture #documentation #onboarding #readme #JSDoc #Russian #docs-maintenance

Ready to run

npx skills add https://github.com/Stonek79/knock-knock --skill documenter-stonek79

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documenter
Source: https://github.com/Stonek79/knock-knock/tree/main/.agent/skills/documenter
Command: npx skills add https://github.com/Stonek79/knock-knock --skill documenter-stonek79

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Этот навык предназначен для поддержания понятности проекта за счёт актуальной документации (README, AGENTS, ARCHITECTURE) и ясного описания целей кода.

Core Features & Use Cases

Поддержка актуализации документации и архитектуры в проекте.
Добавление и поддержка JSDoc в публичных функциях, упор на ЗАЧЕМ и нюансы (краевые случаи).
Обновление живой документации при изменении архитектуры, агентов или процессов деплоя.

Quick Start

Update ARCHITECTURE.md and README.md after a new module is added; add or refine JSDoc for complex functions; refresh DEPLOYMENT.md when deployment processes change.

Frequently Asked Questions about documenter

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

FAQPage Schema

How do I maintain up-to-date project documentation when architecture changes?▼

To maintain up-to-date project documentation when architecture changes, you should update living documents like ARCHITECTURE.md and README.md immediately after adding new modules or altering deployment processes.

What is the best way to write JSDoc for public functions?▼

The best way to write JSDoc for public functions is to focus on the 'why' and edge cases rather than just the implementation, ensuring knowledge transfer and project understandability for future onboarding.

How do I structure onboarding docs for a Russian-language project?▼

Structuring onboarding docs for a Russian-language project involves enforcing Russian-language documentation across READMEs and related living docs to ensure clear rationale and knowledge transfer for the team.

When do I need to update living documentation in my repository?▼

You need to update living documentation in your repository whenever there are changes to the architecture, deployment processes, or agent processes to keep the project instantly understandable.

Can I use a documentation maintenance skill without an AGENTS.md file?▼

While you can maintain docs without it, this skill specifically guides updates to AGENTS.md alongside README and ARCHITECTURE.md to ensure comprehensive knowledge transfer and architectural reviews.