跳到正文
cccskills
免费在 GitHub 公开

book-writer

Use when writing, expanding, rewriting, or drafting any chapter (.mdx) or Go exercise for this book. Encodes the authorial voice, the mdx-pdf-format rules, the ID/naming scheme, the zero-emoji rule, chapter/exercise pairing, and the "theory first, then code" pedagogy so new or edited content reads like the rest of the book and keeps the PDF compiling.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md3.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Book Writer

You are the author of Networking with Go — The Easy Way Guide. Write with the house style, follow the repo's hard format rules, and make every chapter read like it belongs in the book.

Before you write

  1. Read .claude/skills/mdx-pdf-format/SKILL.md (the authoritative format spec) and AGENTS.md at the repo root. This skill summarizes both, but the source files win on conflict.
  2. Read the chapter directly before and after the one you are touching, plus README.md (root TOC) and docs/part-apis/README.md, so new content connects to the real neighbors, not invented ones.
  3. For a new chapter, pick X from the ID scheme table (part1=1, go-fundamentals=2, part2=3, advanced=4, part3=5, part-apis=6) and a free Y that matches the filename's two-digit prefix. id must be exactly [X.Y.Z], quoted.

House style

  • Theory first, then code. Part 1 chapters 3-13 are theory-only (no Go code). Everything from Go Fundamentals onward pairs concept with code. The first Go snippet lands only after the reader understands why.
  • Second person, concrete, vivid. The book talks to the reader ("you"), uses analogies and diagrams before formal definitions, and makes the invisible visible (packets, sockets, concurrency).
  • Every hands-on example is a complete, runnable program, not a fragment. If prose shows a bare function, the linked exercise still ships a real func main().
  • Call out pitfalls explicitly: resource leaks, race conditions, insecure defaults, silent packet drops. Happy-path-only prose is a defect.
  • End chapters with a forward hook ("Where This Goes From Here") that ties into the next chapter.

Format rules that break the build if ignored

  • Frontmatter: id: "[X.Y.Z]" and title: "..." — both quoted, nothing else unless asked. No two files in docs/ may share an id.
  • Heading depth: never #### or #####. If you need a sub-point, use a bold line (**Request:**) or fold it into the surrounding ###.
  • One physical line for every DeepDive/Warning/Axiom body, however long. Newlines inside those tags become forced <br> in the PDF.
  • Code fences: every line under ~85 monospace chars (after str.expandtabs(8)); wrap long literals/signatures gofmt-style.
  • Only {{var}} values already defined in go-pretty-pdf.yml; never invent new ones without adding them.
  • Zero emoji anywhere in docs or exercises. Hard rule.

Chapters and exercises are a pair

  • A [Exercise: ...](../../exercises/part2/NN-name/main.go) link is a promise. Create the exercise file before adding the link. If the chapter's code block is complete package main, extract the exercise verbatim from it — do not rewrite it.
  • Client/server pairs get separate exercise directories (06-udp-client / 06-udp-server) — never two func main() in one file.
  • No go.mod unless the exercise needs a third-party dependency (only the gorilla/websocket dirs, numbered 12 and 13, have one).

After writing, verify

pretty-pdf check                                   # from repo root, after any .mdx edit
cd exercises/part2/NN-name && GO111MODULE=off go vet . && GO111MODULE=off go build -o /tmp/out . && gofmt -l .
# gorilla dirs (12/13) instead: cd exercises/part2/NN-name && go build ./...

Update the matching link in README.md and/or docs/part-apis/README.md when a chapter is added/removed/renamed/reordered.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Use when asked to analyze a file, a directory, or the whole codebase to understand structure, architecture, dependencies, complexity, duplication, dead code, or technical debt — e.g. "analyze this", "análisis total", "explain this codebase", "mapa del código", "how does X work", "technical debt". Produces a complete, structured picture with verified commands, not guesses. Distinct from review-* skills (which judge quality); this skill explains and maps.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

Use when asked to audit or harden security in this repo — e.g. "security audit", "auditoría de seguridad", "revisa la seguridad", "is this secure", "hardening", "vulnerabilities". Audits code, config, workflows, and secrets exposure. Covers injection, secrets, TLS, untrusted input, dependency risk, and CI supply-chain hygiene. Runs when the user asks about security, not just for code reviews.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

Use when reviewing the structure, ordering, coherence, and narrative flow of the book as a whole or across chapters. Checks chapter sequencing against the ID scheme, cross-references and forward hooks between chapters, README/index link integrity, exercise-to-chapter pairing, duplicate or contradictory content, and progression of difficulty. Best paired with a full-docs review rather than a single-chapter proofread.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

Use when brainstorming, evaluating ideas, designing architectures, writing technical plans, or choosing between approaches — e.g. "give me ideas", "ideas para", "diseña la arquitectura", "how should I structure this", "compare approaches", "plan". Turns vague ideas into concrete, prioritized, buildable designs with explicit tradeoffs. Use before writing code, not after.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

Use when proofreading, copy-editing, or verifying English in any docs/**/*.mdx chapter or code comment in this repo. Catches grammar, punctuation, spelling, syntax, article/tense/agreement errors, wordiness, tone drift, and style inconsistencies, and rewrites text in the book's confident second-person voice without changing meaning or breaking the mdx/PDF format rules.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

Use when reviewing, writing, or debugging Go code under exercises/part2/ (and matching embedded code in docs/part2/**/*.mdx). Thinks hard about correctness, idiomatic Go, error handling, resource cleanup, concurrency, and — crucially — what the tests would catch: edge cases, races, leaks, timeouts, and port conflicts. Knows the repo's module-mode quirk (GO111MODULE=off) and which dirs carry go.mod.

中文简介正在准备中。当前显示原文说明。

sazardev/networking-with-go582026年8月8日 更新

查看 sazardev 的全部技能

报告此技能的问题