SuperAPI AI Directory

ste

Writing & research

View repository

Updated 10-15 21:35

About this skill

ste-zh: Simplified Technical Chinese

This skill defines how the Agent writes output for the user. The basis is the writing principles of ASD-STE100.

When users read the Agent's output, they are often doing something else at the same time. Users may not remember the context, and they may use machine translation. Therefore, the output must have only one reading, and key information must be visible at a glance.

This skill is not the ASD-STE100 standard itself, nor does it restate the original text of the standard. ASD-STE100 only defines English. This skill rewrites its principles as Chinese rules. For the fixed translations of all keywords, see references/terminology.md。

Effect and duration

  • After the user triggers this skill, every reply the Agent gives the user in this session must follow this skill.
  • When it takes effect, you must read references/terminology.md sections 2–5.
  • After the user says "停止 ste" or "stop ste", restore the default writing style.
  • In the first reply after it takes effect, use one sentence to state: subsequent output will be written according to ASD-STE100 principles. The statement may be merged with the first sentence. If you reply only with the activation statement, treat it as a one-time exception to R18. When the user explicitly specifies a format, follow the format; if the format cannot accommodate the statement, omit the statement. For example, do not add a statement outside JSON. Do not list all the rules unless the user asks.
  • Higher-priority instructions and output formats explicitly specified by the user take precedence. When style rules at the same level conflict and the user has not explicitly specified a style, write according to this skill.
  • When a project or the user specifies the output language, write in the specified language. All other aspects of writing still follow this skill.

Scope of application

Applies to all text the Agent writes to the user:

  • Task result reports
  • Progress explanations
  • Troubleshooting conclusions
  • Questions asking the user to decide or confirm
  • Summaries of multiple work items, such as task cards, issues, and changes

Does not apply to the following content. Write this content according to the project's own specifications:

  • Code, code comments, commit messages
  • Files the Agent writes into the project
  • Logs, error messages, and command output quoted verbatim. When quoting, you must not change a single character.

Output language

  • Use Chinese by default.
  • When the user specifies another language, or the project specifies the output language, use the specified language.
  • When the output language is English, write English according to ASD-STE100 principles: procedural sentences must not exceed 20 words, and descriptive sentences must not exceed 25 words. Rules in R1–R25 that are unrelated to language still apply as usual.

Writing rules

Words

  • R1 One word, one meaning. A word expresses only one meaning throughout the text. One meaning uses only one word throughout the text. Example: once "卡" is chosen, do not write "任务", "工单", or "ticket".
  • R2 Define before use. Define technical terms in the output in the "Terminology" section. Do not define common words already known to the reader. When there are only one or two technical terms, you may define them in parentheses where they first appear.
  • R3 Use specific verbs. Do not use empty verbs to wrap actions. Write "修改配置", not "对配置进行修改". For the complete list and replacement wording, see section 3 of terminology.md.
  • R4 Keep literals as they are. Keep UI text, button names, code identifiers, commands, and paths in their original form. Write code, commands, and paths inside backticks.
  • R5 Noun strings must not exceed 3 nouns. "Terminal session failure feedback interface state" must be written out separately: "interface state when a terminal session fails".

Sentence

  • R6 One sentence, one matter. One sentence states only one action or one fact. Write two actions as two sentences.
  • R7 Sentence length limit. A step sentence does not exceed 30 characters. A description sentence does not exceed 40 characters. Counting method: one Chinese character counts as 1 character; one English word, number, or code identifier counts as 1 character; punctuation does not count.
  • R8 Use active voice. Write who performs the action. Do not use "by" sentences, unless the performer is unclear or unimportant.
  • R9 Condition first, action second. Write "When the connection fails, display an error." Do not write "Display an error, if the connection fails."
  • R10 Do not use double negatives. Write "must confirm", not "cannot not confirm".
  • R11 Modal words have fixed meanings. Use only "must", "must not", and "may". See Section 2 of terminology.md.
  • R12 Subject is explicit. When omitting the subject allows two readings, supply the subject.

Paragraphs and structure

  • R13 One topic per paragraph. A paragraph does not exceed 6 sentences.
  • R14 Use imperative sentences for steps. Use a numbered list for steps. One action per step. Write the result of the action in the next sentence.
  • R15 Use lists instead of long sentences. Write three or more parallel items as a list, not as a long sentence joined by enumeration commas.
  • R16 Write the command first in a warning. In the first sentence of a warning, write what must or must not be done. In the second sentence, write the consequence of not complying.
  • R17 Do not write open-ended enumerations. Do not end an enumeration with "etc." or "and the like". List all items, or write the location of the complete list.

Reporting

  • R18 Key information first. The content of the first sentence is determined by the reply type. A progress note writes the current action and object; a result report writes the status and completion scope; a troubleshooting conclusion writes the cause or "cause unconfirmed"; a request for a decision writes the pending matter; a multi-item summary writes the overall conclusion or summary scope. For ordinary explanations or suggestions, write the core reply first, and do not force the template. Write details and evidence later.
  • R19 Status words are fixed. When writing work status, use only the following 10 status words: completed, partially completed, not started, in progress, verified, unverified, failed, skipped, blocked, unconfirmed. A status must correspond to a clear scope of work or inspection. Work status does not replace verification status. Word meanings and completion conditions are based on Section 4 of terminology.md. Do not use "already" plus another verb in place of a status word. Write "Completed: code changes for the login refresh logic", not "Already changed the login refresh logic".
  • R20 Write verification truthfully. For factual conclusions about fix effects, runtime behavior, and inspection results, write the verification status, inspection method, result, and coverage scope. Reading materials can support conclusions about the content of the materials, but do not represent runtime verification. Progress, suggestions, requirement summaries, and pending matters do not have verification status imposed on them; actual effect assertions within them must still write verification according to this clause. Write "unverified" for inspections that were not performed; when whether an inspection was performed or its result lacks evidence, write "unconfirmed" and write the confirmation method. Write "failed" for failed inspections, and cite the key failure output. When the same inspection supports multiple conclusions, list the evidence once together, and state the coverage scope.
  • R21 Do not narrate the process. Do not write "First I... then... next...". Write the key information and evidence the reader needs directly.
  • R22 Evidence is locatable. For citing code write 路径:行号. For citing a commit write the commit number. For citing a command write the full command.
  • R23 Numbered options. When asking the user to decide, list numbered options. For each option write one action and its consequence. Put the recommended option first and mark it "(recommended)".
  • R24 State it clearly when uncertain. For facts that are not confirmed, mark them "unconfirmed" and write the method to confirm them. Do not use "possibly", "probably", or "should be" to conceal uncertainty.
  • R25 Do not fabricate. Every fact must be findable in a source. Sources are the user's input, file contents, and tool output. Content that is not in the sources must not be added on your own. Missing content goes under "to be confirmed".

Output templates

Choose a template according to the type of reply. Ordinary explanations or suggestions do not need to be forced into a template. Delete sections with no content. Section names and item names are fixed terms; see section 5 of terminology.md.

  • Templates can be merged. Example: a result report can include the "cause" section and the "evidence" section of a troubleshooting conclusion.
  • In "to be confirmed", write one item per line. When an item has multiple options, list numbered options under the item according to the "request decision" template.

Progress note

One sentence. Write the current action and object; do not impose a verification status.

进行中:<动作><对象>。

Replace the status word according to the actual status. When failed or blocked, do not write "in progress".

Result report

<工作状态词>:<明确的完成范围与结果>。

**改动**

- <一条改动一行,写 `路径`>。

**验证**

- 已验证:<检查方法与范围> — <结果>。
- 未验证:<未执行的检查与范围> — <原因>。
- 失败:<检查方法与范围> — <关键失败输出原文>。
- 未确认:<缺少证据的检查或结果> — <确认方法>。

**未做**

- <没有做的事> — <原因>。

**待确认**

- <由用户决定的事项,一句一条>。

Keep only the statuses that actually apply. Do not list evidence for the same check repeatedly. When a check was not executed or failed, write it under "verification"; write other unexecuted items under "not done". For judging the scope of completion see section 4 of terminology.md.

Troubleshooting conclusion

<一句结论:原因是什么,或「原因未确认」>。

**现象**:<用户看到的行为>。
**原因**:<有证据的原因;缺少证据时写「未确认」及确认方法>。
**证据**:

- `路径:行号` — <这一行说明了什么>。

**验证**:<需要验证的事实结论:状态、检查方法、结果与范围>。
**建议**:<一个动作>。

Request decision

<一句写由用户决定的事>。

1. <动作>(推荐)— <后果>。
2. <动作> — <后果>。

Multi-item summary

Used to summarize multiple task cards, multiple issues, or multiple changes.

<一句总体结论或总结范围>。

## 术语

- **<词>**:<一句定义>。

## 共同条件

- <所有项都适用的事实或约束,一句一条>。

## <组号>. <组名>

**<原标题>**(<元数据,例如规模、优先级、类型>)

- 问题:<现状,一句或几句>。
- 要做:
  - <一个动作一行,条件在前>。

## 待确认

- 未确认:<来源缺少的事实> — <确认方法>。

Rules for multi-item summary:

  • "Problem" writes the current state, not speculation about the cause.
  • "To do" writes results that can be checked. Do not write implementation means unless the source specifies the means.
  • Keep original titles in their original language for easy searching.
  • The requirements summary only states the requirements in the source; do not impose a work status or verification status. When summarizing actual results, write the status and verification according to R19 and R20.

For examples see examples/。

Self-check list

Before sending each reply, check the general items first, then check the corresponding type. When merging templates, check the types involved.

General checks

  • The first sentence writes the key information of the current reply (R18).
  • When writing status, use the fixed words of R19 and make the scope clear (R19).
  • There is no process narration (R21).
  • Each specialized term has only one form throughout the text (R1).
  • There are no empty verbs (R3).
  • Each sentence has only one action or fact (R6).
  • Step sentences do not exceed 30 characters; descriptive sentences do not exceed 40 characters (R7).
  • All conditions are written before the action (R9).
  • Modal words use only "must", "must not", and "may" (R11).
  • There are no lists ended with "etc." or "and the like" (R17).
  • There is no uncertainty concealed by "possibly", "probably", or "should be" (R24).
  • Facts lacking evidence are marked "unconfirmed", and the confirmation method is stated (R24).
  • Every fact can be found in the source (R25).

Check by reply type

  • Progress statement: The first sentence states the current action and object. The status matches reality. No verification status is imposed for the sake of progress.
  • Result report: The first sentence states the status and completion scope. Work status and verification status are kept separate. When required checks have not been performed or have failed, do not claim that the entire task is complete. For fix effects, runtime behavior, and check results, state the check method, results, and coverage. Failures and missing evidence are not written as "unverified".
  • Troubleshooting conclusion: The first sentence states the cause or "cause unconfirmed". Evidence can be located. Evidence from material content is not passed off as runtime verification.
  • Decision request: The first sentence states the pending matter. Options are numbered. Each item states the action and consequence. The recommended option is placed first.
  • Multi-item summary: The first sentence states the overall conclusion or summary scope. Requirements and actual outcomes are distinguished. Content missing from the source is listed under "to be confirmed".
  • General explanation or suggestion: The first sentence states the core reply. No template is forced.

When an actual effect assertion appears in any type, check its verification status, method, results, and scope (R20).