skills.rest
CalcMark
CalcMarkOFFICIAL
Explore all skills by this author →
GitHub

document-refresh

Audit and refresh CalcMark documentation across Hugo site, CLI help, and examples.

4|1|Updated Nov 9, 2025
Search Tags:#documentation#technical writing#code sync#examples#hugo#cli help
One-click install
npx skills add https://github.com/CalcMark/go-calcmark --skill document-refresh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-refresh
Source: https://github.com/CalcMark/go-calcmark/tree/main/.claude/skills/document-refresh
Command: npx skills add https://github.com/CalcMark/go-calcmark --skill document-refresh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill ensures that all documentation for the CalcMark project—including the Hugo website, CLI help text, and worked examples—remains accurate, up-to-date, and consistent with the codebase.

Core Features & Use Cases

  • Comprehensive Audit: Verifies documentation accuracy against the codebase's feature registry, units, and functions.
  • Content Refresh: Updates or removes stale content and adds documentation for new features.
  • Example Authoring: Proposes and authors new worked examples to showcase CalcMark's capabilities.
  • AI Agent Documentation: Creates a dedicated page for AI agents detailing the pipe interface and programmatic interaction.
  • Use Case: When a new calculation function is added to CalcMark, this Skill will automatically update the language reference, user guide, CLI help, and add a relevant worked example to demonstrate its usage.

Quick Start

Run the document refresh skill to audit and update all CalcMark documentation.

Frequently Asked Questions about document-refresh

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

FAQPage Schema
How do I keep technical documentation in sync with code changes?▼

To keep technical documentation in sync with code changes, you audit docs against the codebase feature registry to update language references, CLI help text, and Hugo site content automatically.

What does a documentation audit check for in a codebase?▼

A documentation audit verifies that Hugo site guides, CLI help, and worked examples accurately match the functions, units, and features registered in the codebase.

How do I update Hugo site content when new calculation functions are added?▼

To update Hugo site content for new functions, you refresh documentation by adding feature descriptions, removing deprecated content, and authoring worked examples demonstrating the new capabilities.

Can I generate CLI help text from existing code features?▼

Yes, you can synchronize CLI help text by auditing the codebase feature registry and extending CLI documentation to reflect the latest programmatic interactions and calculation functions.

What is the best way to document an AI agent pipe interface?▼

The best way to document an AI agent pipe interface is to author a dedicated page detailing programmatic interactions alongside existing language specifications and user guides.

When should I remove deprecated content from technical guides?▼

You should remove deprecated content from technical guides during a comprehensive documentation refresh to ensure user-facing materials remain accurate and consistent with current codebase features.

Related Skills

Explore More Software Engineering Skills→
mealpacmealpac
1

mcp-ecosystem-optimizer

Assess MCP servers and generate a multi-phase implementation plan.

Community
Advanced
quaid-appquaid-app
3

CLI Command Wiring

Wire new CLI commands into squad-cli with routing and help text.

Official
Advanced
php-testophp-testo
203

testo-inline-tests

Attach inline test cases to pure functions for deterministic output validation.

Official
Intermediate
BennettPhilBennettPhil

md-link-checker

Validate local file references and remote URLs in Markdown files.

Community
Intermediate