update-docs

Update project documentation after coding sessions by journaling and syncing state files.

1|Updated Apr 11, 2026
One-click install
npx skills add https://github.com/Jaggia/backTestingTraderBot --skill update-docs-jaggia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/Jaggia/backTestingTraderBot/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/Jaggia/backTestingTraderBot --skill update-docs-jaggia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates and standardizes post-implementation documentation. It writes a journal entry, updates _state.md and _modules.md, and fixes stale README.md and CLAUDE.md content, ensuring documentation reflects the latest code changes.

Core Features & Use Cases

  • Journal entry generation that records what changed and why
  • State and module documentation synchronization (updates journal/docs/_state.md and journal/docs/_modules.md)
  • README.md and CLAUDE.md cleanup to match current project structure

Quick Start

Run the update-docs skill after implementing features to generate a journal entry and refresh project documentation.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep project documentation in sync after a coding session?

You can keep project documentation in sync after coding by running a documentation update workflow that journals recent changes, syncs state and module files, and fixes stale README.md and CLAUDE.md content automatically.

What is the best way to automate README and CLAUDE.md updates when code changes?

Automating README and CLAUDE.md updates is best handled by a post-implementation documentation skill that detects stale content and refreshes it to match the current project structure alongside generating a journal entry.

How does journaling work for project state management and documentation?

Journaling for project state management works by recording what changed and why in a journal directory, then updating index, state, and module documentation files to reflect the latest code modifications.

Do I need any specific dependencies to update project docs automatically?

You do not need any specific dependencies to update project docs automatically, as the skill operates without external packages but requires access to your journal directory and key documentation files like README.md and CLAUDE.md.

Can I use a documentation sync workflow for fixing stale content in markdown files?

Yes, you can use a documentation sync workflow for fixing stale content in markdown files, as it specifically targets and updates outdated sections in README.md and CLAUDE.md to align with recent code changes.

When should I run a documentation update workflow for my project?

You should run a documentation update workflow immediately after implementing new features or making significant code changes, ensuring your journal entries, state files, and project documentation accurately reflect the latest updates.