Skip to content

Auto-generate job aid docs #25

@danmaps

Description

@danmaps

Goal

Automatically document job aids (step-by-step guides) from CLI usage or templates.

Why

Job aids are useful but easy to skip. Automating them keeps documentation aligned with real workflows.

Ideas

  • Add a command (e.g., arcgispro job-aid) that outputs a Markdown template
  • Capture inputs/outputs from runs and append to a job aid log
  • Provide a lightweight YAML/JSON schema for job aid metadata

Acceptance

  • A simple command can generate a new job aid stub
  • Output is Markdown and friendly to check into a repo

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions