Agent skill

Doc Writer

by go-spring in go-spring/go-spring

用于编写、改写、审阅或扩展 Go-Spring 文档。写作前应核对源码、测试、示例和已有文档;当目标文档属于已约束范围时,遵守 Go-Spring 文档写作规范。

Apache-2.0Auto-check passedDevelopment

Install Doc Writer

skills CLI
$ npx skills add go-spring/go-spring --skill doc-writer -a claude-code

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

GitHub CLI
$ gh skill install go-spring/go-spring doc-writer --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/go-spring/go-spring.git skills-src && mkdir -p .claude/skills && cp -r skills-src/temp/doc-writer .claude/skills/doc-writer && 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-writer
GitHub stars
1.8k
Token cost
~354 tokens
SKILL.md length
65 words
Files
7 (incl. references)
Skills in repo
2
Repo updated
First seen
Licence
Apache-2.0

At a glance

用于编写、改写、审阅或扩展 Go-Spring 文档。写作前应核对源码、测试、示例和已有文档;当目标文档属于已约束范围时,遵守 Go-Spring 文档写作规范。

  • Development work in your project
  • SKILL.md covers 工作流程 and 按需读取
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Doc Writer is an agent skill from go-spring/go-spring. 用于编写、改写、审阅或扩展 Go-Spring 文档。写作前应核对源码、测试、示例和已有文档;当目标文档属于已约束范围时,遵守 Go-Spring 文档写作规范。

Its SKILL.md is about 350 tokens, which your agent loads only when the skill is triggered. The skill folder holds 8 other files, including reference files (for example `checklists/final-review.md`, `references/doc-types.md` and `references/example-docs.md`).

It sits in Development. It works with Spring Boot. The repository describes itself as: 🔥 [released] 基于 IoC 的 IDLs-First 的 Go 后端一站式开发框架 ( All-in-One Development Framework on IoC and IDLs-First for Go ) 🚀. The licence is Apache-2.0.

When your agent uses it

  • Development work in your project

Example prompts

  • “/doc-writer”

What it can do on your machine

Read from SKILL.md and the folder at commit 4e81262. 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 Writer loads about 354 tokens when it runs, and up to ~8k if it reads all its reference files. Until then it costs about 23 tokens; SKILL.md has 65 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~23
When it runs · the whole SKILL.md, loaded when a task matches
~354
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8k

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 go-spring/go-spring at commit 4e81262, republished under its Apache-2.0 licence (© go-spring). 65 words, ~354 tokens.

Download SKILL.mdSave it as .claude/skills/doc-writer/SKILL.md (or your agent's skills folder). This skill also uses 6 other files; get the full folder from GitHub.
name
doc-writer
description
用于编写、改写、审阅或扩展 Go-Spring 文档。写作前应核对源码、测试、示例和已有文档;当目标文档属于已约束范围时,遵守 Go-Spring 文档写作规范。

Go-Spring 文档编写者

当需要编写、改写、审阅或扩展 Go-Spring 文档时使用本技能,包括新增文档、重写文档、结构调整、术语统一、示例补充、FAQ 和集成文档。

工作流程

判断文档类型

先确认文档承担的读者任务,避免把所有文档都写成同一种 Guide。

  • 判断目标属于项目概览、快速开始、Guide、Integration、Example、FAQ、Changelog 还是贡献文档。
  • 类型或结构不明确时,读取 references/doc-types.md。
核对事实来源

事实准确性优先于表达完整性。文档可以暂时少写,但不能补不存在或未确认的 API、配置和行为。

  • 写入 API、配置 key、默认值、行为、版本或状态前,先从源码、测试、示例或已有文档中确认。
  • 涉及事实性内容时,读取 references/fact-checking.md。
  • 无法确认的内容不要编写成确定结论,应保留为待确认点或改写为概念性描述。
选择适用规则

写作规范只约束已经分析过的文档范围,不把局部风格强行扩展到整个 docs/ 目录。

  • 当目标文档位于 docs/0.overview/、docs/1.getting-started/、docs/2.guides/ 或 docs/4.integrations/ 时,读取并遵守 references/writing-style.md。
  • 其他目录暂不强制套用该规则,只保持事实准确、术语清晰和结构可读。
按文档目的组织内容

结构应服务于读者要完成的任务,而不是服务于模板本身。

  • 使用型文档优先给出最小可运行或最小可理解路径。
  • 解释型文档先建立心智模型,再展开机制、边界和实践。
  • 默认使用中文写作,除非目标文档已经是英文,或用户明确要求使用其他语言。
交付前自检

交付前做一次面向读者和事实准确性的检查,避免留下看似完整但不可验证的内容。

  • 按 checklists/final-review.md 检查示例上下文、术语、链接、限制和边界行为。
  • 说明修改范围。
  • 说明是否做过校验;如果没有校验,应说明原因。

按需读取

场景文件
不确定文档类型或结构references/doc-types.md
涉及 API、配置、默认值、版本或行为references/fact-checking.md
修改受约束目录文档references/writing-style.md
修改示例索引或示例 READMEreferences/example-docs.md
修改 FAQ、贡献文档或 Changelogreferences/maintenance-docs.md
交付前检查checklists/final-review.md

© go-spring, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 6 other files (references) in temp/doc-writer of go-spring/go-spring.

  • SKILL.md
  • checklists/final-review.md
  • references/doc-types.md
  • references/example-docs.md
  • references/fact-checking.md
  • references/maintenance-docs.md
  • references/writing-style.md

Open the folder on GitHubat commit 4e81262

Compare with similar skills

Doc Writer 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 Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Doc Writer this skillgo-spring/go-spring1.8k—~354Automated safety check: PassApache-2.0
Groovy 5 Developer Guideapache/grails-core2.9k—~3kAutomated safety check: PassApache-2.0
Logging Patternsdecebals/claude-code-java7501 repos~3.3kAutomated safety check: PassMIT
Ij Debuggerxpinjection/test-driven-spring-boot112—~6.4kAutomated safety check: PassMIT
Readme GenerateJuncai22/spring-ai-agent-learning123—~2.2kAutomated safety check: PassApache-2.0
Java Coding Standardsaffaan-m/ECC274k1 repos~2.9kAutomated safety check: PassMIT

Similar skills

  • Groovy 5 Developer Guide

    apache/grails-core

    Guidance for Groovy 5 work in Grails projects: syntax, closures, traits, DSLs, metaprogramming, Spock tests, static compilation and Java 21 integration.

    2.9k GitHub stars~3k tokensUpdated today
    DevelopmentAuto-check passed
  • Logging Patterns

    decebals/claude-code-java

    Java logging best practices with SLF4J, structured logging (JSON), and MDC for request tracing.

    750 GitHub starsUsed in 1 repo~3.3k tokens
    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
  • Readme Generate

    Juncai22/spring-ai-agent-learning

    Generates comprehensive README.md files for Spring Boot modules based on task specification requirements

    123 GitHub stars~2.2k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Java coding standards for Spring Boot and Quarkus services: naming, immutability, Optional usage, streams, exceptions, generics, CDI, reactive patterns, and project layout.

    274k GitHub starsUsed in 1 repo~2.9k tokens
    DevelopmentAuto-check passed
  • Java Coding Standards

    vibeeval/vibecosystem

    Java coding standards for Spring Boot services: naming, immutability, Optional usage, streams, exceptions, generics, and project layout.

    531 GitHub starsUsed in 3 repos~877 tokens
    DevelopmentAuto-check passed

More from go-spring/go-spring

  • Gs

    go-spring/go-spring

    Go-Spring 项目研发托管入口:一句话诉求经 规划(Plan)→ 执行(Execute)→ 交付(Settle)循环,从工具集(起骨架/加接口/重生成/接组件/补测试)中选取组合并落地。在 Go-Spring 项目中开展任一研发任务时触发;由 Plan 判定是否接管,超范围时放手。

    1.8k GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed

Works with

Questions about Doc Writer

What does Doc Writer do?

用于编写、改写、审阅或扩展 Go-Spring 文档。写作前应核对源码、测试、示例和已有文档;当目标文档属于已约束范围时,遵守 Go-Spring 文档写作规范。. Doc Writer is an agent skill from go-spring/go-spring.

When should I use Doc Writer?

Doc Writer fits situations like: development work in your project.

How do I install Doc Writer in Claude Code?

Run `npx skills add go-spring/go-spring --skill doc-writer -a claude-code`. Or copy the skill folder (temp/doc-writer in go-spring/go-spring) into .claude/skills/doc-writer in your project. Claude Code loads it when a task matches its description.

How do I install Doc Writer in Codex?

Run `npx skills add go-spring/go-spring --skill doc-writer -a codex`. Or copy the skill folder (temp/doc-writer in go-spring/go-spring) into .agents/skills/doc-writer in your project. Codex loads it when a task matches its description.

Can I use Doc Writer 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 go-spring/go-spring --skill doc-writer -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-writer, .gemini/skills/doc-writer, .github/skills/doc-writer and .opencode/skills/doc-writer in your project.

What does Doc Writer need to run?

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

Does Doc Writer 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 Writer 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 Writer use?

Doc Writer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Doc Writer use?

About 354 tokens (SKILL.md is roughly 1.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.7k tokens, read only when the agent opens those files.

What are the alternatives to Doc Writer?

Skills that share tags, products or a category with Doc Writer: Groovy 5 Developer Guide (apache/grails-core, 2.9k stars), Logging Patterns (decebals/claude-code-java, 750 stars), Ij Debugger (xpinjection/test-driven-spring-boot, 112 stars) and Readme Generate (Juncai22/spring-ai-agent-learning, 123 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Doc Writer?

go-spring (a GitHub organization) maintains it in go-spring/go-spring, which has 1,803 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 6, 2026.

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