skills.rest
fwdslsh
fwdslshOFFICIAL
Explore all skills by this author →
WebsiteGitHub

doc-writer

Generate and improve Markdown documentation for JavaScript projects.

2|Updated Dec 12, 2025
Search Tags:#documentation#api#readme#jsdoc#docs
One-click install
npx skills add https://github.com/fwdslsh/crosstrain --skill doc-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/fwdslsh/crosstrain/tree/main/src/tests/fixtures/skills/doc-writer
Command: npx skills add https://github.com/fwdslsh/crosstrain --skill doc-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates creation and enhancement of documentation, including READMEs, API docs, and comments.

Core Features & Use Cases

  • Generate API documentation
  • Create README files
  • Generate JSDoc comments
  • Improve existing docs

Quick Start

Use the skill to draft documentation for a new module and generate supporting docs.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I generate API documentation for JavaScript projects?▼

API documentation generation transforms code into structured Markdown with endpoint descriptions, parameters, and code examples. This Skill automates that process for JavaScript projects, producing documentation compatible with standard API doc tools and formats.

Can I use this to create and improve README files?▼

Yes. This Skill generates README files from scratch and enhances existing ones. It produces Markdown-formatted files with proper structure, code blocks, and sections tailored to project needs.

What's the best way to generate JSDoc comments across a codebase?▼

JSDoc comment generation creates structured inline documentation for functions and modules. This Skill automates JSDoc creation, ensuring consistency and compatibility with documentation tooling and API standards.

Does this work with existing documentation I want to improve?▼

Yes. This Skill improves existing docs by refining structure, clarity, and completeness while maintaining compatibility with automated tooling and API documentation standards.

Can I generate documentation with code snippets and versioned revisions?▼

Yes. This Skill produces Markdown output with embedded code snippet blocks and supports versioned revisions, meeting requirements for comprehensive API documentation and automated doc generation workflows.

Related Skills

Explore More Content & Communication Skills→
agentscope-aiagentscope-ai
28.7k

Analyzing AgentScope Library

Extract signatures and documentation from AgentScope modules using Python's inspect module.

Official
Intermediate
officebeatsofficebeats
8

document-exporter

Convert Markdown files to PDF, HTML, and DOCX with embedded assets.

Community
Intermediate
greyhaven-aigreyhaven-ai
29

grey-haven-documentation-alignment

Validate code implementations against documentation across signatures, types, and examples.

Community
Intermediate
Varnan-TechVarnan-Tech
581

docs-from-code

Generate README.md and API reference docs from a codebase knowledge graph.

Official
Advanced