Place Project Manager Comments

Insert project manager notes explaining intent and rationale into code changes.

Updated Dec 27, 2018
One-click install
npx skills add https://github.com/segersniels/dotfiles --skill place-project-manager-comments
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Place Project Manager Comments
Source: https://github.com/segersniels/dotfiles/tree/main/.codex/skills/pm-comment
Command: npx skills add https://github.com/segersniels/dotfiles --skill place-project-manager-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams understand the intent behind changes by embedding high-level project manager comments directly into code changes, reducing cognitive load for reviewers.

Core Features & Use Cases

  • Comment insertion: Add high level PM notes at change points to summarize the rationale.
  • Rationale summaries: Capture decisions, tradeoffs, and acceptance criteria to guide future work.
  • Use Case: When reviewing a PR, PM comments clarify intent without detailing technical implementation.

Quick Start

Review the latest changes and insert concise, high-level PM notes explaining intent and rationale.

Frequently Asked Questions about Place Project Manager Comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add project manager comments to a pull request to explain change rationale?

To add project manager comments to a pull request, you insert high-level PM notes directly into the code changes. This clarifies the intent, decisions, and tradeoffs for reviewers without detailing the technical implementation.

What is the best way to document project management decisions within code commits?

Documenting project management decisions within code commits involves embedding concise, high-level notes that summarize the rationale. This ensures consistent PM-centered comments are placed within code diffs to guide future work and reduce cognitive load.

Why include high-level rationale notes in code diffs instead of technical comments?

Including high-level rationale notes in code diffs captures the intent behind changes rather than the technical details. This approach reduces cognitive load for reviewers and ensures team alignment by explaining decisions and acceptance criteria.

Can I use this approach to summarize tradeoffs and acceptance criteria across multiple branches?

Yes, you can apply this approach across multiple files, branches, and pull requests. It consistently inserts high-level project manager notes that summarize tradeoffs and acceptance criteria, guiding reviewers through various code review scenarios.

When do I need to insert PM-centered comments during change management?

You need to insert PM-centered comments during change management when you want to clarify the intent behind code modifications. This is done at change points to summarize rationale and guide reviewers in understanding project-level decisions.

Does this method work for team alignment without detailing technical implementation in review notes?

This method works for team alignment by embedding high-level project manager notes that describe intent and rationale. It guides reviewers by explaining tradeoffs and decisions without detailing the underlying technical implementation.