SuperAPI AI 工具集

chinese-documentation

写作与研究

查看项目

更新于 10-16 09:30

技能介绍

用途:提供一套中文技术文档写作规范,解决中英文混排无空格、全角半角混用、句式欧化与机翻味等常见问题,让文档读起来自然、专业、一致。参考标准为中文文案排版指北。

主要能力:一是排版规范,规定中英文之间、中文与数字之间、数字与单位之间加空格,链接前后加空格,度数、百分比等例外不加;中文语境使用全角标点,英文或数字内容使用半角标点,全角标点与英文数字之间不加空格;数字统一使用半角阿拉伯数字,技术参数不用中文数字。二是术语处理,专有名词(React、Kubernetes、Redis、MySQL)、行业缩写(API、SDK、CLI、ORM、CI/CD)、命令代码、协议标准保留英文;有公认翻译的通用概念译成中文;术语首次出现标注中英对照,避免过度翻译如把 Redis 写成「远程字典服务」。三是文档模板,提供 API 接口文档模板(基本信息、请求参数表、请求示例、响应参数、响应示例、错误码,字段名中英对照)和 README 中文模板(项目名、徽章、简介、特性、快速开始、环境要求、安装、基本用法、文档、示例、贡献指南、许可证)。四是常见问题清单,针对机翻味、欧化长句、过度翻译、中英标点混用、缺乏结构化给出正反示例,并附发布前检查清单(排版、术语、内容、格式四类)。

使用方式:资料未提供该技能的安装命令或调用方式,暂未提供。可按文档中的规范与模板人工套用,或作为写作与审校时的检查依据。

适用场景:中文技术文档、API 文档、README、使用指南等写作与校对,尤其适合中英混排较多的项目文档。

限制:资料仅给出写作规范与示例模板,未说明其具体运行环境、依赖、自动化能力或与其他工具集成方式,也未提供收费、价格与效果数据。