Skip to main content

13 docs tagged with "authoring"

View all tags

brainstorm-spec

For an ad-hoc dev task with no PRD — brainstorm the approach, converge on a short written spec, and get explicit approval BEFORE writing code. A lightweight design-before-code gate. Triggers on "let's design this", "how should I approach", "brainstorm this".

Breakdown — task / design → GitHub issues

Break a feature / ClickUp parent task / design doc into one or more GitHub issues with the BeWith 6-section template + AI-assigned effort/urgency/domain labels. Triggers on phrases like "break down this task", "create issues for this design", "פצל את המשימה הזאת ל-issues".

cto-review

Opens a CTO-review ticket in a dedicated ClickUp list, carrying the full handoff package (problem, UI composition, design reference, acceptance criteria, links). Title convention [Feature name] informative title, tag cto review. Runs at the end of the product flow or manually off-flow.

Decision record — discussion → durable record → tasks

Capture a discussion that reached decisions into a durable record — an ADR (technical) or a decision log entry (product/business) — then offer to break its action items into tasks via /breakdown. Worktree-isolated. Triggers on "record this decision", "תעד את ההחלטה".

design-an-interface

Turn a screen/feature requirement into a concrete UI composition from the design system — which COMPONENTS.md components, layout, states, and tokens — the machine-consumable design reference when there's no Figma (Path B). Flags gaps as /add-component; never invents components or raw hex.

Draft proposal

Turn a feature / infrastructure / process idea into a markdown file under docs/proposals/ in bewith-docs. Worktree-isolated, safe across concurrent sessions. Invoked by /propose or by Claude after the developer confirms.

i18next-translation

Find hardcoded user-facing strings, replace them with t() calls, and add the keys to both he/en locale files. Use when translating components, internationalizing text, or converting hardcoded strings. Owned by i18n-localization; used by frontend-developer.

incident-report

Render a finished incident / investigation into a browser-viewable RTL-Hebrew HTML report artifact (via the Artifact tool) — root cause, evidence, impact, timeline, fix. Use after investigating, not for finding bugs (see identify-bug).

insight

Capture a what's-missing / could-change POC observation into docs/insights/ — fast, separate from proposals. Worktree-isolated. Invoked by /insight or when the developer voices a gap or possible change during the build. Does NOT create a proposal; the 2-3 day review promotes agreed insights.

mermaid-diagrams

Create version-controllable software diagrams with Mermaid's text syntax — flowcharts, sequence, class, ERD, C4/architecture, state. Use when documenting architecture, a data model, an API/auth flow, or a DB schema, or any "diagram / visualize / map out the flow" request.

New artifact authoring

Create or update a platform artifact (agent, skill, command, rule, hook, policy) in bewith-docs. Walks the artifact-types decision tree, audits for duplication, drafts file(s), opens a PR. Triggers on phrases like "create an agent", "add a skill", "צריך command".

postman-endpoint

Save an added or changed HTTP endpoint in the organization R&D Postman workspace with a sample request and a saved response example, at the end of development. The Definition-of-Done step for API work — keeps the collection an accurate, runnable contract. Never commits secrets.

Propose team rule

Turn a generic insight into a reviewable PR on bewith-docs for team discussion. Worktree-isolated, safe across concurrent sessions. Invoked by /share-rule or by Claude after the developer confirms. Never auto-invoke without explicit approval — each PR consumes review attention.