skills.rest
wagnerra23
wagnerra23COMMUNITY
Explore all skills by this author →
GitHub

brief-update

Regenerate executive BRIEFING.md files for affected ERP modules after merged PRs.

Updated May 14, 2024
Search Tags:#briefing#exec summary#PR merge#module documentation#audit log#spec tracking#capterra inventory
One-click install
npx skills add https://github.com/wagnerra23/oimpresso.com --skill brief-update
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: brief-update
Source: https://github.com/wagnerra23/oimpresso.com/tree/main/.claude/skills/brief-update
Command: npx skills add https://github.com/wagnerra23/oimpresso.com --skill brief-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents stale, inconsistent module documentation by automatically regenerating each module’s one-page executive BRIEFING after meaningful changes in code, UX, or market positioning.

Core Features & Use Cases

  • Auto-regenerates canonic BRIEFING: Updates memory/requisitos/<Modulo>/BRIEFING.md using SPEC, AUDIT-LOG, CAPTERRA-INVENTARIO, and recent handoffs/sessions.
  • Diff-based module detection: Identifies which Modules/<X>/ (and relevant resources/js/Pages/<X>/) were affected by a merged PR and updates only those modules.
  • Exec summary within strict limits: Produces a compact briefing (target ≤ 150 lines) and refreshes the §13 “Atualizado” section without deleting historical content.
  • Guardrails against noise: Skips updates for chore/test/refactor-only changes and avoids inventing percentages when canonical sources are stale.

Quick Start

Ask the AI to atualizar briefing for a specific module X using the latest merged PR context so it can regenerate memory/requisitos/<Modulo>/BRIEFING.md from the canonical sources.

Frequently Asked Questions about brief-update

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

FAQPage Schema
How do I auto-generate executive summaries for ERP modules after merging a PR?▼

To auto-generate executive summaries, trigger a briefing regeneration that detects affected modules from merged PR diffs and updates memory/requisitos/<Modulo>/BRIEFING.md using canonical SPEC, audit log, and inventory sources.

How does diff-based module detection work for updating module documentation?▼

Diff-based module detection identifies which Modules/<X>/ and related frontend pages were modified by a merged PR, then regenerates the one-page BRIEFING.md only for those specific affected modules using canonical sources.

What is the best way to keep module briefings within a strict one-page limit?▼

Keeping module briefings within a one-page limit requires regenerating the compact summary with a target of 150 lines, updating only the timestamp section while preserving all prior historical content sections intact.

Does this documentation regeneration skip chore and refactor-only code changes?▼

Yes, the documentation regeneration includes guardrails that skip updates for chore, test, or refactor-only changes, and avoids inventing coverage percentages when canonical documentation sources are stale.

Can I use audit logs and competitive positioning data to refresh module specs?▼

You can use audit logs and competitive positioning data from CAPTERRA-INVENTARIO alongside SPEC files to refresh module specs, computing dimension coverage and updating the timestamp without deleting historical sections.

Why does my module briefing not update after minor frontend page modifications?▼

Module briefings may not update after minor modifications if the changes are classified as chore, test, or refactor-only, which are intentionally skipped to prevent noise and unnecessary documentation updates.

Related Skills

Explore More Product & Management Skills→
warpdotdevwarpdotdev
292

security-review-spec

Audit design-spec PR diffs for security risks and trust boundaries.

Official
Advanced
ewanyuanewanyuan
45

cox

Manage AI project planning, task tracking, and observability dashboards.

Community
Advanced
tvishwanadhatvishwanadha

review-documentation

Audit project documentation for accuracy, completeness, and consistency.

Community
Intermediate
gclmgclm

knowgtzh

Generate concise summaries of GitHub Trending projects using WebFetch or WebSearch.

Community
Advanced