Skip to content

Conversation

@schafeld
Copy link

Claude Code – Building a Documentation Generator

The following prompt was created using the course task. Then it was used with Github Copilot and Claude Sonnet 4 in Agent mode.

TODO:

  • Add screenshot functionality

Prompt

Build a Claude Code command that automatically generates both technical documentation for developers and user-friendly guides for end users when you add a new feature.

Use the existing command file: .claude/commands/document-feature.md

Write a command that takes a feature name and generates:

  1. Developer Documentation - Technical specs, API details, implementation notes
  2. User Documentation - Simple guide with screenshots placeholders, step-by-step instructions

Command Structure
The command should:

  • Accept a feature name as input
  • Analyze the relevant code files
  • Generate two separate documentation files in appropriate directories
  • Follow your project's existing documentation patterns
  • Include placeholders for screenshots in user docs

Add proper cross-references between the two doc types

Example Usage:

document-feature password-reset

Should generate:

docs/dev/password-reset-implementation.md
docs/user/how-to-reset-password.md

Make the command detect if the feature is frontend/backend/full-stack and adjust documentation accordingly.
Make it automatically capture and insert screenshots in user-facing documentation.
Auto-link to related existing documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant