maintain-project-readme
Maintain Project README
Maintain ordinary software-project README.md files through one deterministic README workflow.
Inputs
- Required:
--project-root <path> - Required:
--run-mode <check-only|apply> - Optional:
--readme-path <path>
Workflow
- Validate the project root and resolve the target
README.md. - Detect the repo profile from repo signals such as package metadata, CLI entrypoints, app/service manifests, or workspace files.
- In
check-only, audit title/value proposition, common README sections, the requiredOverview > Motivationstructure, and command integrity. - In
apply, keep edits bounded to the targetREADME.mdwhile repairing missing structure and grounded wording. - Re-run the same audit to confirm post-fix status.
- If the repository is a skills or plugin repo with specialized install and discoverability conventions, use the dedicated
maintain-skills-readmeskill from/Users/galew/Workspace/agent-plugin-skillsinstead.
Output Contract
- Return Markdown plus JSON with:
run_contextprofile_assignmentschema_violationscommand_integrity_issuescontent_quality_issuesfixes_appliedpost_fix_statuserrors
- If there are no issues and no errors, output exactly
No findings.
Guardrails
- Never auto-commit, auto-push, or open a PR.
- Never invent commands, setup steps, or support claims that are not grounded in the repo.
- Never edit files other than the target
README.md. - Do not use this skill for agent-skills, Codex plugin, Claude plugin, or similar skills/plugin repositories. Use the dedicated
maintain-skills-readmeskill from/Users/galew/Workspace/agent-plugin-skillsinstead.
References
agents/openai.yamlreferences/section-schema.mdreferences/profile-model.mdreferences/output-contract.mdreferences/fix-policies.mdreferences/style-rules.mdreferences/verification-checklist.mdreferences/project-readme-maintenance-automation-prompts.md
More from gaelic-ghost/productivity-skills
project-workspace-cleaner
Scan workspace repositories for cleanup opportunities using a read-only hygiene audit. Use when users ask to detect build/cache artifact buildup, stale large transient files, and prioritized cleanup chores by repository and directory.
161project-docs-maintainer
Maintain `*-skills` README standards and checklist-style roadmap docs through one canonical maintenance entrypoint. Use when a repo needs profile-aware README maintenance, checklist roadmap validation or migration, or a bounded audit-first doc workflow with Markdown and JSON reporting.
66things-digest-generator
Generate a week-ahead Things planning digest with recent activity, upcoming deadlines, and concrete next actions. Use when users request Things check-ins, weekly planning summaries, or prioritized planning recommendations.
28things-reminders-manager
Manage Things reminders and todo create/update requests with a deterministic MCP workflow that prevents duplicate tasks and date mistakes. Use when users ask to add, reschedule, or correct Things reminders, especially with relative dates or potential update-vs-create ambiguity.
13speak-with-profile
Profile-aware speech workflow for narrated notes, spoken drafts, audio summaries, accessibility reads, and other text-to-speech tasks. Use when one front-door workflow should resolve voice profiles, enforce disclosure, and apply manifest tracking before delegating to built-in `$speech` or a deterministic local CLI path.
12project-roadmap-manager
Create and maintain a repository-root ROADMAP.md as the single source of truth for project milestones and accepted plans. Use when bootstrapping any new project, accepting/completing a plan, defining or updating milestone/version roadmaps, marking milestones as reached/changed/de-scoped, or answering where roadmap and milestone status should be referenced.
12