Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/plans
History
Jason Stirnaman 63d31907ff feat: add documentation planning structure and CLI sync plan 
Create structured approach for managing recurring documentation tasks:

Benefits:
- Claude can easily reference plans via @plans/[task]/plan-[version].md
- Version-controlled plans alongside code for iteration tracking
- Progress tracking with execution logs for lessons learned
- Reusable templates for recurring documentation patterns
- Organized structure for multiple concurrent documentation tasks

Usage Examples:
- "Claude, execute Phase 1 of @plans/cli-docs-sync/plan-v3.2.0.md"
- "Claude, create plan-v3.3.0.md based on previous plan and new release notes"
- Create similar structures for other recurring documentation tasks

Includes comprehensive CLI documentation sync plan for v3.2.0 with:
- Analysis of existing CLI docs and v3.2.0 changes
- Specific file paths for updates (retention periods, license management)
- Automation strategy for future releases
- Phase-based execution approach

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
 		2025-06-27 14:17:16 -05:00
..
cli-docs-sync feat: add documentation planning structure and CLI sync plan 2025-06-27 14:17:16 -05:00
README.md feat: add documentation planning structure and CLI sync plan 2025-06-27 14:17:16 -05:00

README.md

Documentation Plans

This directory contains plans for recurring documentation tasks and automation.

Active Plans

CLI Documentation Synchronization

  • Location: cli-docs-sync/
  • Purpose: Keep InfluxDB 3 CLI reference documentation in sync with actual CLI commands
  • Current Version: plan-v3.2.0.md
  • Status: Ready for execution

Release Notes Automation

  • Location: release-notes-automation/
  • Purpose: Automate generation of release notes from git commits
  • Scripts: Available in /scripts/generate-release-notes.sh

Plan Structure

Each plan directory should contain:

  • plan-[version].md - The detailed plan
  • execution-log.md - Track progress and notes
  • templates/ - Reusable templates and patterns

Usage for Claude

When working with Claude on these plans:

  1. Reference the specific plan file: @plans/[task]/plan-[version].md
  2. Update execution logs as you progress
  3. Iterate on plans by creating new versions
  4. Use templates for consistency

Best Practices

  • Keep plans versioned by release or iteration
  • Document lessons learned in execution logs
  • Create reusable templates for recurring patterns
  • Link plans to related scripts and automation