技術作家的人工智慧

技術寫作長期以來一直是部分自動化的。參考文件通常是使用 Swagger UI、Redoc 和 Sphinx autodoc 等工具根據程式碼註解或 API 規格產生的。生成式人工智能添加的是散文：概念解释、教程、示例、发行说明以及根据产品需求文档或工程说明编写的初稿。許多團隊都在文件即程式碼模型中工作。文档在 Git 中以 Markdown 或 reStructuredText 形式存在，更改通过拉取请求进行，持续集成使用静态站点生成器（例如 Docusaurus、MkDocs 或 Sphinx）构建站点。這種設置非常適合人工智慧。草稿作為可審查的變更到達，每次提交都會執行自動檢查，並且文件更新可以與導致它們的程式碼變更相關聯。為了風格的一致性，確定性工具和人工智慧相輔相成。像 Vale 这样的 linter 会强制执行风格指南中的规则，例如 Google 的开发人员文档风格指南或 Microsoft 写作风格指南，并且每次都会给出相同的结果。人工智慧更擅長提出更清晰的措辭，但它的可預測性較差。主要風險是信心不準確。模型可以發明一個端點、一個預設值或一個看起來合理的命令列標誌。它還可以描述產品在訓練資料中的行為方式，而不是現在的行為方式。每個產生的程式碼範例和參數都需要針對真實系統進行檢查。一個常見的誤解是人工智慧讓技術作家變得不必要。這項工作的困難在於了解什麼是真實的、確定使用者需要什麼以及組織資訊以便他們能夠找到它。像 Diátaxis 這樣的框架將教程、操作指南、參考和解釋分開，反映了這種結構性工作。角色正在轉向資訊架構、驗證、內容策略和人工智慧讀者的寫作。例如，2024 年的 llms.txt 提案建議使用一個文件將語言模型指向網站的關鍵文件。