Skip to content

docs(ide): English translation of IDE chapter (Intro, FAQ, NPK, project guides) - #68

Merged
fanghuaqi merged 1 commit into
masterfrom
personal/zhangzegang/20260723_en
Jul 28, 2026
Merged

fanghuaqi merged 1 commit into
masterfrom
personal/zhangzegang/20260723_en

Conversation

@laomaolaile

@laomaolaile laomaolaile commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

This PR translates the IDE documentation from Chinese to English. It covers the IDE chapter including:

  1. Introduction and release notes (source/ide/intro.rst)
  2. FAQ (source/ide/faq.rst)
  3. Advanced usage (source/ide/advanceusage.rst)
  4. NPK overview, creation, management and templates (source/ide/npkoverview.rst, source/ide/npk.rst, source/ide/npkmanage.rst)
  5. Project creation, build and run/debug guides (source/ide/projectnew.rst, source/ide/projectbuild.rst, source/ide/projectrun.rst)

@fanghuaqi fanghuaqi changed the title translate IDE chapter to English docs(ide): English translation of IDE chapter (Intro, FAQ, NPK, project guides) Jul 27, 2026
@fanghuaqi

Copy link
Copy Markdown
Member

主要问题与建议(按优先级)

Reviewed by AI

  1. 公司 / 品牌 名称不一致(重要,影响对外文件)
  • 问题:文档中对“芯来科技”的英文翻译不统一,出现过 "Nuclei System Technology"、"Nuclei"、"Nuclei Studio"、"NucleiStudio" 等多种变体。
  • 建议:选择一种标准用法并全文统一。常见做法:
    • 公司名:Nuclei System Technology(首次出现用全称并括号注明简称),后文简称 Nuclei。
    • 产品名:Nuclei Studio(带空格),文中统一用 "Nuclei Studio"(不要写成 NucleiStudio)。
  • 例:把 "NucleiStudio" 改为 "Nuclei Studio";把 "芯来蜂鸟调试器" 统一翻为 "Nuclei HummingBird debugger"(或供应方常用的英文名),并统一大小写(HummingBird / Hummingbird,选一种)。
  1. 空格与拼写错误会导致命令不可运行(高)
  • 问题示例:projectrun.rst 中出现 "sudo apt install libncursesw5libtinfo5"(缺空格),会误导用户。还有少量把两个单词连在一起的情况。
  • 建议:严格校验所有命令行并保留原始命令的正确空格与标点。常见需修正的有:
    • 正确:sudo apt install libncursesw5 libtinfo5
    • 检查其它类似:ldd $(which riscv-nuclei-elf-gdb) 等命令的空格、反引号/美元括号是否正确。
  1. 产品/功能名称与术语不稳定(中—高)
  • 问题:例如 "Launch Bar"、"HummingBird"、"Nuclei SDK"、"NPK"、"RVProf"、"Nuclei Model" 等,有时大小写或空格不稳(Launchbar / Launch Bar)。
  • 建议:建立术语表并全文替换为一致形式。举例:
    • Launch Bar(首字母大写,两个词)
    • Nuclei Studio(产品)
    • Nuclei SDK(SDK)
    • NPK (Nuclei Package) — 首次出现写全称并括号缩写
    • RVProf / QEMU / OpenOCD / J-Link 等保持官方写法
  1. 读起来生硬或字序直接映射(中)
  • 问题:部分句子保留中文语序或直译,读起来不够地道(例如“默认是开户启了Launch Bar功能。”译为 “enabled by default” 更清晰)。
  • 建议:重写为更自然的表达,并注意动词时态/冠词。例如:
    • 原:In Nuclei Studio 2022.12 and later, the Launch Bar feature is enabled by default.
    • 建议(相同但风格更统一):Nuclei Studio 2022.12 and later enables the Launch Bar by default.
  1. 菜单/路径/按键翻译格式问题(中)
  • 问题:菜单项和键位说明的空格、标点、代码样式(backticks)不一致。例如很多代码片段后面多了空格再逗号: Window -> Preferences , —— 逗号不应与反引号之间有空格。
  • 建议:统一格式:
    • 菜单/命令使用反引号 ... 包裹,紧接标点,例如: Window -> Preferences,(注意逗号在反引号之外但不与反引号有空格)。
    • Windows 菜单路径建议写成 Window -> Perspective -> Reset Perspective
    • 保持一致的箭头符号(->)或使用 ,但全文统一。
  1. 标题与小节风格(可选/低)
  • 问题:标题风格不统一(有些使用 Sentence case,有些 Title Case),有些二级标题长度或措辞不自然(例如 "Nuclei Studio Starts Slowly" 可改为 "Slow startup" 或 "Slow startup of Nuclei Studio")。
  • 建议:统一为 Title Case 或 Sentence case,根据项目风格选一种(我推荐 Title Case 用于章节标题)。统一后再批量替换。
  1. 句子级语法/拼写细节(低)
  • 若干拼写错误或单词拼写问题,如 "Floting Point ABI" -> "Floating Point ABI"、"Debugging and Running Projects in Nuclei Studio" 有时写作 "Nuclei Studio 调试运行工程"(中文),需检查英文版全文拼写。
  • 建议:运行一次英语拼写/语法检查(例如 Grammarly / LanguageTool),并把命中率高的问题修复。
  1. 链接 / 引用样式
  • 问题:文中含大量 URL/refs,翻译时有些地方多余转义/空格或重复 URL。
  • 建议:保证链接文本与 URL 一致;在英文文档中把中文注释去掉或放入括号说明;检查 :ref: 标签能在 Sphinx 中正确解析。

@fanghuaqi

Copy link
Copy Markdown
Member

上面的翻译问题,我大概看了下,确实应该是都存在的,确实IDE文档里面有非常多的typo错误,语法错误,这次让AI一次性全部改好,然后在里面审查下。

你翻译完毕后,直接单独起一个干净的agent,让AI来review下这次翻译内容,看看有什么语义上不一样的地方,再就是有没有什么typo之类的。

@laomaolaile
laomaolaile force-pushed the personal/zhangzegang/20260723_en branch from 0b3a0df to acc8eab Compare July 28, 2026 03:02
@fanghuaqi
fanghuaqi merged commit 5b0bd67 into master Jul 28, 2026
1 check passed
@fanghuaqi
fanghuaqi deleted the personal/zhangzegang/20260723_en branch July 28, 2026 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants