Index of every page on this site: llms.txt
All skills
jetbrains avatar

/writing-specs

@e85862d
by jetbrainsjetbrains/thinkrail8.4k stars
532
Run it yourself

Use when a workflow step drafts or revises a spec artifact — a goal-and-requirements, an architecture, or a module SPEC — or when a workflow skill names it at such a step. The shared quality bar for specs — not a workflow, nothing to execute.

Use this Skill: https://skilld.dev/gh/jetbrains/thinkrail/writing-specs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈66 tokens for metadata: the name and description. ≈675 when used: this file.

Description uses 3.2% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈258 characters, or 3.2%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Writing Specs

The workflow family's shared bar for every spec a workflow produces: short, honest, on-rails. Process skills name this concept at the steps that draft or revise specs; what to draft and when stays with the referencing skill. Graph mechanics — frontmatter, link kinds, the spec_* tools — are the spec-graph skill's ground; this concept carries the quality bar the family holds on top of them, and is where the family's rules for specs and the spec graph accrue.

Short

  • Small enough to read in one sitting. Target signal, not completeness.
  • Explain intent, not inventory: what the thing is for, what it owns, where its boundary runs — never a file listing or a restatement of the code.

Honest

  • Only settled content appears. Never pad with [TBD] or placeholder sections — a section that hasn't been settled simply doesn't exist yet.
  • Anything inferred rather than confirmed is marked unconfirmed, inline, where it stands.
  • New and inferred specs are status: draft until the user has reviewed them — the flip out of draft follows the user's review, never the drafting agent's own judgment. A reviewed durable spec goes active, never done: it stays in force and evolves with the project.

On-rails

  • High-signal enough that a future agent (or human) lands on the decisions without re-deriving them.
  • The spec is the only home for rationale: decisions, invariants, trade-offs, and bug post-mortems are recorded here, never as code comments — a rationale paragraph found in code is content to promote into the owning spec, leaving at most a one-line pointer where misediting would silently break something.
  • Say each thing once: link by id instead of restating; the dependency edges between sibling modules live in the parent's spec, not in each leaf.
  • One spec per genuine boundary — not per directory, not per file.

The goal doc describes the product, not a plan

goal-and-requirements is the living record of what the product is and why: its goal, problem, audience, capabilities, and non-goals, plus any durable principles.

  • No versions, releases, phases, MVP/v1/v2 splits, or "later" lists. Sequencing is not a spec's job: an idea cut from scope goes back to the user to track wherever they plan work, and never into the doc.
  • Capabilities state what the product does, or for a new project what its smallest useful first build will do.
  • Non-goals hold only what is excluded by decision. Something neither listed nor excluded is open, not forbidden.
  • It evolves with the product: a change that adds a capability or overturns a principle updates the goal doc in the same change.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts22d3 checks · Risk SAFE
  • Gen Agent Trust Hub22d

    This skill provides a set of guidelines for drafting and revising project specifications. It contains only instructional text and no executable code, network operations, or security risks.

  • Socket26d

    No alerts

  • Snyk26d

    Risk: LOW · No issues

Signed by skilld at e85862d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 2 months ago

README badge

README badge for jetbrains/thinkrail/writing-specs