关于 ste
ste 是面向技术写作者的表达技能,帮助以清晰、准确的方式解释技术主题。它强调易懂而不牺牲准确性,并明确不认证正式 ASD-STE100 合规性。
主要功能
- 01先说明用途与作用
- 02采用具体、主动的表达
- 03定义缩写和技术术语
- 04区分事实、假设与建议
- 05检查指代和清晰度
适用场景
- 01向读者解释技术组件
- 02理清步骤与因果关系
- 03检查草稿中的模糊措辞
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ 23jmo/ jmo-skills --skill ste安装后在 Claude Code 中输入/ste确认已加载。
详细介绍
清晰的技术英语
解释主题时,应让读者一遍就能理解,同时不损失技术准确性。
撰写说明
- 开头先说明事物的作用及其重要性。
- 每句话只表达一个主要观点。
- 优先使用常见、具体的词语。遇到准确的技术术语时,保留该术语,并在首次出现时加以定义。
- 首次使用缩写时,先写出其全称。
- 优先使用主动语态,并明确指出执行动作的主体:说明每个组件执行了什么操作。
- 直接说明因果关系。
- 按照步骤发生的顺序进行说明。
- 区分已确认的行为、假设和建议。
- 对于抽象的概念,使用一个简短示例。
- 描述步骤或并列事项时使用列表;若观点彼此依赖,则使用段落。
- 删除填充语、含糊的强调语和装饰性术语。
不要为了缩短说明而降低准确性。如果某个细节尚不确定,请指出未知之处,并说明如何验证。
检查结果
完成前,请确认每个代词都有明确的指代对象,每个技术术语都已定义或为目标读者所熟悉,并且每个步骤都说明了发生了什么变化及其原因。
此技能遵循清晰技术沟通的一般目标,但不代表符合 ASD-STE100 正式规范。
评论
支持 Markdown