document-writer

Write or update documentation for the target project at $ARGUMENTS .

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "document-writer" with this command: npx skills add bahayonghang/my-claude-code-settings/bahayonghang-my-claude-code-settings-document-writer

Write or update documentation for the target project at $ARGUMENTS .

Steps

  • If $ARGUMENTS is empty, report an error requesting the target project path.

  • Read references/WORKFLOW.md and references/DOCUMENT_TYPES.md to understand generation standards.

  • Use file reading and search tools to understand the target codebase structure and logic.

  • If writing specific function comments (like JSDoc), find the file using and read it.

  • Create or update the required documentation matching the structures defined in the reference documents.

  • Verify that any generated code examples are valid, paths/links exist, and no internal secrets are exposed.

Execution Rules

  • Base all documentation strictly on the actual code implementation. Do not guess behavior.

  • Use imperative, concise professional tone.

  • Match doc language with codebase (Chinese user requests, output Chinese).

  • If information is missing, explicitly mark it as TODO.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

tech-design-doc

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

article-cover

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

tech-blog

No summary provided by upstream source.

Repository SourceNeeds Review