project-documentation

Project Documentation Skill

A Claude Code skill that automatically documents completed work in journal entries and usage manuals.

What it does

After you complete significant work — a feature, bugfix, infrastructure setup, configuration change — this skill guides Claude to:

1. Write a journal entry recording what was done, when, and why
2. Write a usage manual (when the work involves commands, config, or services someone would need to operate later)

It checks for existing documentation first to avoid duplicates, appending to related entries instead of creating new files.

When it triggers

• After completing any significant piece of work
• When you ask to "document this", "write this up", or "create a journal entry"
• When work involves commands, config files, services, or multi-step setup that needs a manual

Install

# Add the marketplace
claude plugin marketplace add mottlio/project-documentation

# Install the skill
claude plugin install project-documentation

Project structure

The skill looks for documentation directories in this order:

docs/
  journal/     # Chronological work entries (YYYY-MM-DD-description.md)
  manuals/     # Operational reference docs (descriptive-name.md)

If docs/ doesn't exist, it looks for journal/ and manuals/ at the project root. It creates directories as needed but won't reorganize your existing structure.

Pairs well with

This skill works great alongside Superpowers — the core skills library for Claude Code that provides TDD, debugging, planning, and other workflows. Together they cover the full development lifecycle: Superpowers guides how you build, and Project Documentation ensures the work gets recorded.

Examples

Journal entry

# Email Calendar Integration

**Date:** 2026-04-02

## Objective

Add email reading and calendar access to the main Svelt instance via the gws CLI tool.

## What was done

- Installed gws CLI and configured OAuth credentials
- Added exec tool allowlist entries for gws commands
- Created email-triage cron job (hourly, sends Telegram summary)
- Tested end-to-end: read, draft, send, calendar list/create

## Outcome

Email and calendar integration working. Cron job active and delivering summaries.

Manual

# Email & Calendar (gws CLI)

## Overview

Email reading/drafting and calendar management via the gws CLI tool,
connected to [email protected].

## Common operations

### Check email
gws gmail inbox --max 10
gws gmail +triage

### Send a draft
gws gmail draft --to [email protected] --subject "Hello" --body "..."
gws gmail send --id <draft-id>

### View calendar
gws calendar list --today
gws calendar list --days 7

## Troubleshooting

If auth fails, credentials may have expired. Run:
gws-setup-credentials.sh

License

MIT