Readable Docs

One job

Make project technical records easy to scan and use: facts first, findability second, brevity third, natural wording fourth. Write like useful slide notes, not an essay or a slogan deck. Complete information does not require complete sentences.

Apply this style when writing the original text, not only when asked to polish it. It works alongside the active task or memory skill; it does not create an extra report, approval step, or document.

1. Read for meaning

• Read the relevant source and its context. Identify what the reader needs to know, decide, or do.
• For an edit, stay within the requested scope. Do not bulk-rewrite archives, quoted evidence, or unrelated documents.
• Preserve facts and their relationships: actors, actions, causes, conditions, exceptions, negation, alternatives, and uncertainty. Do not turn an observation into a rule or a proposal into a decision.
• Keep exact technical names, paths, commands, configuration keys, versions, dates, numbers, units, and source references. Never invent specifics, experience, opinions, or evidence to make the text feel human.
• Preserve required sections, output paths, status fields, and instruction strength. Shortening “must” into “may” is a behavior change, not copyediting.

2. Structure for scanning

Put the useful conclusion, status, or next action first. Use headings that tell readers what they can find; avoid empty headings such as “综合分析” when “失败后如何恢复” names the actual content.