skills.rest
CJCreator-New
CJCreator-NewCOMMUNITY
Explore all skills by this author →
GitHub

hims-documentation-coach

Improves code documentation, API specs, and onboarding materials for healthcare systems.

Updated Jan 3, 2026
Search Tags:#code quality#documentation#knowledge management#technical writing#api documentation#healthcare IT
One-click install
npx skills add https://github.com/CJCreator-New/care-harmony-hub --skill hims-documentation-coach
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hims-documentation-coach
Source: https://github.com/CJCreator-New/care-harmony-hub/tree/main/.agents/skills/hims-documentation-coach
Command: npx skills add https://github.com/CJCreator-New/care-harmony-hub --skill hims-documentation-coach

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of maintaining clear, consistent, and up-to-date documentation within complex healthcare systems, making the codebase more accessible and maintainable.

Core Features & Use Cases

  • Code Documentation Improvement: Identifies and suggests fixes for missing or outdated JSDoc, docstrings, and XML comments.
  • API Specification Assistance: Helps in writing clear API documentation, including OpenAPI and FHIR CapabilityStatement.
  • Knowledge Management: Recommends Architectural Decision Records (ADRs) and helps structure module documentation (README, architecture.md).
  • Use Case: A new developer joins the team and needs to understand a critical patient data module. This Skill helps generate comprehensive documentation, including ADRs for past decisions and clear API specs, reducing their onboarding time significantly.

Quick Start

Review the documentation for the patient registration module and suggest improvements for clarity and completeness.

Frequently Asked Questions about hims-documentation-coach

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

FAQPage Schema
How do I improve healthcare code documentation for faster onboarding?▼

Healthcare code documentation improves by identifying missing JSDoc or docstrings and applying the why/how/when framework. This ensures codebases become understandable within two weeks by consistently explaining domain terms like UHID and MRN.

What is the best way to write API documentation for FHIR systems?▼

Writing API documentation for FHIR systems requires clear OpenAPI and FHIR CapabilityStatement specifications. Using active voice and imperative mood ensures API endpoints are consistently explained and synchronized with the underlying codebase.

How does an Architectural Decision Record help maintain healthcare IT systems?▼

An Architectural Decision Record (ADR) helps maintain healthcare IT systems by documenting past technical decisions and module structures. Generating ADRs alongside architecture.md files reduces new developer onboarding time by providing immediate context for critical patient data modules.

Can I use this approach to document domain terms like ABHA and IPD No?▼

Yes, documenting domain terms like ABHA and IPD No is supported by enforcing consistent explanations across the codebase. This ensures all healthcare identifiers are clearly defined within code comments, API specifications, and onboarding materials.

How do I keep documentation synchronized with code in healthcare applications?▼

Documentation stays synchronized with code by continuously reviewing and suggesting fixes for outdated comments and API specifications. This active maintenance process prevents knowledge decay and keeps architectural decision records aligned with current system logic.

Related Skills

Explore More Software Engineering Skills→
vvedantbvvedantb
99

ubiquitous-language

Extract domain terms from conversations into a canonical glossary in UBIQUITOUS_LANGUAGE.md.

Community
Advanced
Lautaro073Lautaro073

api-reference-documentation

Generates endpoints, models, and authentication details from OpenAPI 3.0 documents into Markdown-ready content.

Community
Intermediate
EstomEstom

code-documenter

Generate framework-aware documentation with docstrings, OpenAPI specs, and doc sites.

Community
Advanced
JaiminVadadoriyaJaiminVadadoriya
1

qa-project-bootstrap

Guide QA onboarding and new project setup with audit frameworks and documentation templates.

Community
Advanced