Agent skill

Doc View Contract Design

by liuzhihang in liuzhihang/doc-view

A skill your agent uses when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ…

MITAuto-check passedDocuments & Office

Install Doc View Contract Design

skills CLI
$ npx skills add liuzhihang/doc-view --skill doc-view-contract-design -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install liuzhihang/doc-view doc-view-contract-design --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/liuzhihang/doc-view.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.codex/skills/doc-view-contract-design .claude/skills/doc-view-contract-design && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
doc-view-contract-design
GitHub stars
207
Token cost
~539 tokens
SKILL.md length
226 words
Files
1
Skills in repo
4
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ…

  • Works in 7 steps: Identify the observable area:… → Confirm an apply-ready OpenSpec change… → Define… → …
  • Reviewing Doc View behavior contracts before changing PSI parsing
  • SKILL.md covers Read First, Steps and Guardrails
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Doc View Contract Design is an agent skill from liuzhihang/doc-view. Use when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ compatibility.

Its SKILL.md is about 540 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Documents & Office. It works with JetBrains IDEs and Java. The repository describes itself as: IDEA 插件 Doc View 的仓库地址. The licence is MIT.

When your agent uses it

  • Reviewing Doc View behavior contracts before changing PSI parsing
  • Markdown output
  • UI-visible behavior
  • IntelliJ compatibility

Example prompts

  • “/doc-view-contract-design”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Identify the observable area: Spring/Feign/Dubbo PSI, DTO, Markdown, export, upload, settings, UI, performance, or compatibility.
  2. Confirm an apply-ready OpenSpec change exists for behavior work; write normative requirements to its specs/, not docs/contracts/.
  3. Define Java/settings/platform/external-service inputs and assumptions.
  4. Define expected DocView/Body/Param/Header, Markdown, payload, UI, notification, or compatibility outputs.
  5. Define unsupported, fallback, sensitive-data, and explicitly unchanged cases.
  6. Choose direct validation: PSI fixture, DTO assertion, golden Markdown, payload check, runIde, or Plugin Verifier.
  7. Review recursion, user-template, IntelliJ lifecycle, EDT, and secret-handling risks.

What it can do on your machine

Read from SKILL.md and the folder at commit 00f1f94. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Doc View Contract Design loads about 539 tokens when it runs. Until then it costs about 53 tokens; SKILL.md has 226 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~53
When it runs · the whole SKILL.md, loaded when a task matches
~539

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from liuzhihang/doc-view at commit 00f1f94, republished under its MIT licence (© liuzhihang). 226 words, ~539 tokens.

Download SKILL.mdSave it as .claude/skills/doc-view-contract-design/SKILL.md (or your agent's skills folder).
name
doc-view-contract-design
description
Use when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ compatibility.

Doc View Contract Design

Use this skill before implementation work that changes user-visible or integration-visible behavior. OpenSpec owns proposal/design/spec/tasks; this skill supplies Doc View domain checks.

Read First

  • AGENTS.md
  • docs/contract-design.md
  • The active change status and every contextFiles path returned by openspec instructions apply --change <name> --json
  • docs/architecture.md when package, service, DTO, settings, extension, or data flow boundaries are involved
  • docs/performance-guide.md when PSI, UI, rendering, export, upload, recursion, or cache performance can change
  • docs/intellij-compatibility.md when IntelliJ API, Gradle platform, descriptor, extension, or compatibility behavior is involved

Steps

  1. Identify the observable area: Spring/Feign/Dubbo PSI, DTO, Markdown, export, upload, settings, UI, performance, or compatibility.
  2. Confirm an apply-ready OpenSpec change exists for behavior work; write normative requirements to its specs/**, not docs/contracts/**.
  3. Define Java/settings/platform/external-service inputs and assumptions.
  4. Define expected DocView/Body/Param/Header, Markdown, payload, UI, notification, or compatibility outputs.
  5. Define unsupported, fallback, sensitive-data, and explicitly unchanged cases.
  6. Choose direct validation: PSI fixture, DTO assertion, golden Markdown, payload check, runIde, or Plugin Verifier.
  7. Review recursion, user-template, IntelliJ lifecycle, EDT, and secret-handling risks.

Guardrails

  • Do not change Java while only designing the contract.
  • Do not create a parallel contract under docs/contracts/**; OpenSpec specs are normative.
  • Do not include real tokens, production URLs, or private user code in artifacts or fixtures.
  • Do not make implementation details normative unless users or integrations observe them.
  • Keep later production implementation Java-only.

© liuzhihang, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .codex/skills/doc-view-contract-design of liuzhihang/doc-view.

Open the folder on GitHubat commit 00f1f94

Compare with similar skills

Doc View Contract Design next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Doc View Contract Design compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Doc View Contract Design this skillliuzhihang/doc-view207—~539Automated safety check: PassMIT
Release Pluginflutter/flutter-intellij2k—~1kAutomated safety check: PassBSD-3-Clause
Code StyleJetBrains/intellij-community21k—~795Automated safety check: PassCustom licence
Jugg Android Dev Loopniki914/zafiro235—~2kAutomated safety check: PassMIT
Amplicode InstallAmplicode/spring-skills128—~2.6kAutomated safety check: PassNone
Idea MCPdtprj/dongting208—~698Automated safety check: PassApache-2.0

Similar skills

  • Release Plugin

    flutter/flutter-intellij

    Prepare and execute a new release for the flutter-intellij plugin, including updating dependencies, compatibility bounds, changelogs, and verification.

    2k GitHub stars~1k tokensUpdated yesterday
    MobileAuto-check passed
  • Code Style

    JetBrains/intellij-community

    Official

    Apply IntelliJ Kotlin and Java code style when writing or reviewing.

    21k GitHub stars~795 tokensUpdated today
    MobileAuto-check passed
  • Jugg Android Dev Loop

    niki914/zafiro

    A skill your agent uses when editing source files (Java/Kotlin/XML/layout/AndroidManifest/Gradle) in a Android project, or when user asks to build/deploy/verify an Android app.

    235 GitHub stars~2k tokensUpdated yesterday
    MobileAuto-check passed
  • Amplicode Install

    Amplicode/spring-skills

    Installs the Amplicode IntelliJ plugin into IntelliJ IDEA (Ultimate/Community) and GigaIDE on the user's machine.

    128 GitHub stars~2.6k tokensUpdated 1 mo ago
    Agent WorkflowsAuto-check passed
  • Idea MCP

    dtprj/dongting

    IntelliJ IDEA MCP for Java code analysis, testing, refactoring, and project navigation.

    208 GitHub stars~698 tokensUpdated today
    DevelopmentAuto-check passed
  • Ij Debugger

    xpinjection/test-driven-spring-boot

    Debugger-first runtime root-cause analysis for JVM code in IntelliJ IDEA.

    112 GitHub stars~6.4k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from liuzhihang/doc-view

  • Doc View Docs Maintenance

    liuzhihang/doc-view

    A skill your agent uses when creating or updating Doc View repository documentation, AGENTS.md, AI workflow guidance, OpenSpec configuration, or repo-local Codex skills.

    207 GitHub stars~456 tokensUpdated 24 days ago
    Auto-check passed
  • Doc View Java Maintenance

    liuzhihang/doc-view

    A skill your agent uses when implementing or reviewing Java-only Doc View production changes, especially PSI parsing, services, DTOs, UI, integrations, settings, export, or IntelliJ Platform behavior.

    207 GitHub stars~557 tokensUpdated 24 days ago
    Auto-check passed
  • Doc View Release Readiness

    liuzhihang/doc-view

    A skill your agent uses when preparing, checking, or reviewing a Doc View plugin release, including changelog, version, plugin verification, manual IDE validation, Marketplace preparation, and…

    207 GitHub stars~494 tokensUpdated 24 days ago
    Auto-check passed

Questions about Doc View Contract Design

What does Doc View Contract Design do?

A skill your agent uses when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ…. Doc View Contract Design is an agent skill from liuzhihang/doc-view. Use when defining or reviewing Doc View behavior contracts before changing PSI parsing, DTOs, Markdown output, uploads, exports, settings, UI-visible behavior, or IntelliJ compatibility.

When should I use Doc View Contract Design?

Doc View Contract Design fits situations like: reviewing Doc View behavior contracts before changing PSI parsing; markdown output; UI-visible behavior; intelliJ compatibility.

How do I install Doc View Contract Design in Claude Code?

Run `npx skills add liuzhihang/doc-view --skill doc-view-contract-design -a claude-code`. Or copy the skill folder (.codex/skills/doc-view-contract-design in liuzhihang/doc-view) into .claude/skills/doc-view-contract-design in your project. Claude Code loads it when a task matches its description.

How do I install Doc View Contract Design in Codex?

Run `npx skills add liuzhihang/doc-view --skill doc-view-contract-design -a codex`. Or copy the skill folder (.codex/skills/doc-view-contract-design in liuzhihang/doc-view) into .agents/skills/doc-view-contract-design in your project. Codex loads it when a task matches its description.

Can I use Doc View Contract Design in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add liuzhihang/doc-view --skill doc-view-contract-design -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-view-contract-design, .gemini/skills/doc-view-contract-design, .github/skills/doc-view-contract-design and .opencode/skills/doc-view-contract-design in your project.

What does Doc View Contract Design need to run?

SKILL.md names no scripts, command-line tools or credentials: Doc View Contract Design is instructions for the agent only.

Does Doc View Contract Design access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Doc View Contract Design safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Doc View Contract Design use?

Doc View Contract Design is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Doc View Contract Design use?

About 539 tokens (SKILL.md is roughly 2.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Doc View Contract Design?

Skills that share tags, products or a category with Doc View Contract Design: Release Plugin (flutter/flutter-intellij, 2k stars), Code Style (JetBrains/intellij-community, 21k stars), Jugg Android Dev Loop (niki914/zafiro, 235 stars) and Amplicode Install (Amplicode/spring-skills, 128 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Doc View Contract Design?

liuzhihang (a GitHub user) maintains it in liuzhihang/doc-view, which has 207 GitHub stars. The repository holds 4 skills in this directory. The repository was last updated on September 16, 2026.

Source: liuzhihang/doc-view on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.