SDK Examples & Changelog Writing

SDK示例与变更日志撰写

Create professional-grade SDK examples and product changelogs that facilitate developer adoption and keep users informed about product evolution. This skill focuses on technical clarity, code usability, and clear value communication.

创建专业级别的SDK示例和产品变更日志，助力开发者快速上手，同时让用户及时了解产品演进。本Skill聚焦技术清晰度、代码易用性以及明确的价值传递。

Core Objectives

核心目标

Produce clean, working code examples for SDKs
Communicate product updates through clear, structured changelogs
Facilitate developer "Time to First Hello World"
Bridge the gap between technical engineering and user-facing marketing
Maintain a consistent history of product improvement

生成简洁、可运行的SDK代码示例
通过清晰、结构化的变更日志传递产品更新信息
缩短开发者“首次运行Hello World”的时间
打通技术开发与面向用户的营销之间的壁垒
保留产品改进的完整历史记录

Mandatory Elements

必备要素

1. SDK Documentation

1. SDK文档

Getting Started: Clear installation instructions (npm, pip, etc.).
Code Snippets: Concise, copy-pasteable examples for core functions.
Contextual Comments: Explaining "why" certain parameters are used.

快速入门： 清晰的安装说明（npm、pip等）。
代码片段： 针对核心功能的简洁、可复制粘贴的示例。
上下文注释： 解释使用特定参数的原因。

2. Changelog Structure

2. 变更日志结构

Semantic Versioning: Clear version numbers (e.g., v1.2.0).
Categorization: Added, Changed, Deprecated, Removed, Fixed, Security.
User Impact: Explaining what the change means for the user.

语义化版本控制： 清晰的版本号（例如v1.2.0）。
分类： 新增、变更、弃用、移除、修复、安全。
用户影响： 说明变更对用户的意义。

Structure & Frameworks

结构与框架

The "Perfect Example" Framework

“完美示例”框架

Prerequisites: What you need before running the code.
The Code: The most minimal version that achieves the goal.
The Explanation: Breakdown of key components.
The Output: What the developer should expect to see.

前置条件： 运行代码前需要准备的内容。
代码： 实现目标的最简版本。
说明： 关键组件的拆解。
输出结果： 开发者预期看到的内容。

Changelog Writing Standard

变更日志撰写标准

Clarity over Cleverness: "Fixed bug in auth" is better than "Polishing the gates."
Action-Oriented: Use verbs like "Added," "Improved," "Fixed."
Link to Docs: Always link to new documentation for significant feature updates.

清晰优先： “修复认证模块漏洞”比“优化权限校验机制”更直白。
动作导向： 使用“新增”“改进”“修复”等动词。
关联文档： 重大功能更新时，始终链接至新文档。

Voice & Tone Guidelines

语气与风格指南

Developer-Centric: Precise, efficient, and respect the developer's time.
Transparent: Honest about bugs fixed and changes made.
Concise: No fluff. Get straight to the technical point.
Formatting: Heavy use of backticks for code symbols and markdown tables for changelogs.

以开发者为中心： 精准、高效，尊重开发者的时间。
透明： 如实说明修复的漏洞和做出的变更。
简洁： 摒弃冗余内容，直击技术要点。
格式： 大量使用反引号标注代码符号，使用Markdown表格呈现变更日志。

Concrete Examples

具体示例

SDK Example: Authentication

SDK示例：认证

javascript

import { Client } from 'click-campaigns-sdk';

// Initialize the client
const client = new Client({
  apiKey: process.env.CC_API_KEY
});

// Fetch your first campaign
const campaign = await client.campaigns.get('camp_123');
console.log(`Successfully fetched: ${campaign.name}`);