skills.rest
reynalivan
reynalivanCOMMUNITY
Explore all skills by this author →
GitHub

code-documentation

Document Rust and TypeScript code with standardized annotations and templates.

Updated Feb 15, 2026
Search Tags:#typescript#documentation#adr#readme#rust#tsdoc
One-click install
npx skills add https://github.com/reynalivan/EMMM2 --skill code-documentation-reynalivan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/reynalivan/EMMM2/tree/main/.agent/skills/code-documentation
Command: npx skills add https://github.com/reynalivan/EMMM2 --skill code-documentation-reynalivan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Codebases often lack uniform documentation, making it hard to understand public APIs, modules, and architectural decisions. This skill defines a standard for Rust and TypeScript docs to improve readability and maintainability.

Core Features & Use Cases

  • Enforces doc comments on public items (Rust) and TSDoc on components (TypeScript).
  • Provides module-level documentation guidelines and ADR templates to capture architectural decisions.
  • Centralizes references to Rust and TS documentation styles for quick onboarding and consistency.

Quick Start

Review and apply the established Rust and TypeScript documentation standards to new and existing code.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I standardize Rust documentation and TypeScript TSDoc comments across a codebase?▼

To standardize Rust documentation and TypeScript TSDoc comments, apply consistent doc comment rules to all public API items and module-level documentation. This ensures uniform readability and maintainability across the entire project.

What is the best way to document architectural decisions in a Rust and TypeScript project?▼

Documenting architectural decisions is best handled using ADR templates. These templates capture architectural choices alongside module-level documentation guidelines, providing a centralized reference for consistent onboarding and decision tracking.

How do I enforce TSDoc annotations on TypeScript components and public Rust items?▼

Enforce TSDoc annotations on TypeScript components and doc comments on public Rust items by applying established documentation standards. Centralized references ensure codebase-wide consistency for public API surfaces.

Do I need specific templates to maintain code documentation standards for Rust and TypeScript?▼

You need specific ADR and documentation templates to maintain code documentation standards for Rust and TypeScript. These templates specify how to annotate public APIs and module-level docs, ensuring consistent practices.

When should I use module-level documentation guidelines in my codebase?▼

Use module-level documentation guidelines when onboarding new developers or standardizing existing code. Establishing these guidelines alongside ADR templates clarifies architectural decisions and improves overall codebase readability.

Can I apply a single documentation standard across both Rust and TypeScript code?▼

You can apply a unified documentation standard across Rust and TypeScript code by enforcing doc comments for Rust public items and TSDoc for TypeScript components. Centralized references provide consistent styling for both languages.

Related Skills

Explore More Software Engineering Skills→
youdotcom-ossyoudotcom-oss
5

code-documentation

Generate and maintain TSDoc comments for TypeScript and JavaScript codebases.

Official
Advanced
icartshicartsh
4

markdown-pro

Generate READMEs, changelogs, and API references from Git history.

Community
Advanced
PracticalSwanPracticalSwan
7

documentation-automation

Configure markdownlint, link checkers, and pre-commit hooks for documentation validation.

Community
Intermediate
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic