跳到正文
cccskills
免费在 GitHub 公开

good-docs-writing

Draft or revise technical documentation in a direct, friendly style based on Modal's documentation. Lead with the concept or benefit, place a runnable example near the top, and reduce jargon and vague promotional wording.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Writing style guide derived from Modal's documentation voice. Apply when writing or editing docs, guides, tutorials, or technical prose that should read direct, second-person, confident, low-jargon, and example-first. Use to draft new docs in this voice or to revise existing prose toward it.

查看安装方法

适用场景

  • Draft a guide that starts with a runnable example
  • Rewrite technical prose in a direct, friendly voice
  • Standardize wording and formatting across documentation

包含的文件(2)

  • SKILL.md1.4 KB
  • references/style-guide.md5.6 KB

SKILL.md(原文)

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

Good docs writing

Write docs the way Modal writes them: direct, friendly, confident, and ruthlessly practical. Explain the why in one breath, then show working code. Treat the reader as a capable developer who wants to ship, not a student who needs a lecture.

Read references/style-guide.md for the full rule set (Voice, Structure, Terminology, Punctuation, Code examples, Formatting) and apply every rule while drafting.

The rules that matter most, before you open the reference:

  • Address the reader as "you", never "the user" or "one".
  • Open with the concept or benefit in the first sentence. No throat-clearing.
  • Put a minimal runnable example near the top, then explain what just happened.
  • Remove every em-dash. Use a period, comma, colon, or parentheses instead.
  • Cut vague intensifiers ("seamlessly", "powerful", "robust", "cutting-edge"). Show a thing being easy instead of calling it easy.
  • Backtick every code identifier, command, parameter, path, and filename.

To review existing prose against these rules instead of drafting, use good-docs-audit.

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Fix defects in Composio SDK through focused reproduction, root-cause analysis, regression tests that check for recurrence, and targeted verification. Use it for reported bugs, failing tests, CI regressions, runtime errors, or incorrect SDK behavior.

中文简介正在准备中。当前显示英语简介。

  • Reproducing and fixing reported SDK bugs
  • Investigating failing tests
  • Fixing regressions in automated CI checks
ComposioHQ/composio3.1万2026年10月19日 更新

Design, implement, and review Composio CLI commands, including user interactions, output, errors, and configuration. It guides command wiring and service changes using Effect and effect/cli, with references for implementation patterns.

中文简介正在准备中。当前显示英语简介。

  • Designing CLI command behavior and output
  • Implementing command wiring with Effect
  • Reviewing configuration and error handling
ComposioHQ/composio3.1万2026年10月19日 更新

cli-e2e

免费

Create, update, and debug Docker-based end-to-end tests for the Composio CLI. Covers running the executable, keeping test data separate, checking command output, and maintaining package manifests within the CLI test suite.

中文简介正在准备中。当前显示英语简介。

  • Add end-to-end tests for CLI commands
  • Debug unexpected CLI test output
  • Keep test data isolated between tests
ComposioHQ/composio3.1万2026年10月19日 更新

Build beta versions of the Composio CLI, promote a tested beta to a stable release, and investigate failed releases. Guides verification of published binaries and installation tests through the Build CLI Binaries workflow.

中文简介正在准备中。当前显示英语简介。

  • Build a CLI beta release
  • Promote a tested beta to stable
  • Verify release assets and installation
ComposioHQ/composio3.1万2026年10月19日 更新

composio

免费

Set up and use Composio to connect AI agents with apps such as Gmail, Slack, and Notion. Selects guidance for personal accounts or product integrations, covering setup, app operations, troubleshooting, and migration.

中文简介正在准备中。当前显示英语简介。

  • Connect a personal AI agent to apps
  • Integrate account connections into a product
  • Diagnose failed connections or tool calls
ComposioHQ/composio3.1万2026年10月19日 更新

Keep TypeScript and Python SDKs consistent when shared behavior or backend APIs change. Aligns public API names, use of generated clients, and documentation examples, including updates to the fixed versions of generated clients.

中文简介正在准备中。当前显示英语简介。

  • Align a change across both SDKs
  • Compare TypeScript and Python behavior
  • Update fixed versions of generated clients
ComposioHQ/composio3.1万2026年10月19日 更新

查看 ComposioHQ 的全部技能

报告此技能的问题