Writerside文檔創(chuàng)作工具 v2024.3

Writerside官方版是一款專為開發(fā)人員打造的文檔編輯軟件，旨在為他們提供一個高效協(xié)作編寫文檔和教程的平臺。通過這款軟件，用戶可以集中創(chuàng)建API和產品文檔，無需在多個工具間頻繁切換……這款軟件集成了多種強大的功能，例如實時預覽、內置檢查，協(xié)作與整合等，提升文檔編寫人員的工作效率，幫助他們更快地完成高質量文檔的編寫。還搭載了JetBrains構建的語法糾正器與人工智能的拼寫檢查器，支持超過英語、德語、西班牙語和中文 等25 種語言，大幅提高文檔的準確性和可讀性。

除此之外，writerside既可作為獨立工具使用，也可以作為JetBrains IDE的插件運行，為用戶提供靈活的選擇和使用方式。有需要的用戶快來本站下載試試吧~

軟件功能

1、文檔即代碼環(huán)境（Docs-as-code pipeline）：該工具內置了GitUI，使用戶無需過多關注布局和CSS設計等細節(jié)，專注于編寫核心內容。

2、支持Markdown和XML組合使用：開發(fā)者可以在Markdown中注入語義屬性或元素以豐富內容，并將Markdown元素轉換為XML。

3、文檔內容檢測（Doc quality automation）：內置超過100個測試，幫助自動檢測損壞的鏈接、丟失的資源、不正確的屬性值和非唯一ID等問題。

4、具有代碼高亮顯示和驗證功能：實時預覽（Livepreview）功能使文檔內容能夠按照用戶實際看到的方式實時顯示，無需等待構建完成。

軟件優(yōu)點

1、協(xié)作與整合：Writerside的一個主要目標是在開發(fā)人員和作者之間實現有效的協(xié)作，彌合他們之間的差距。它基于開發(fā)工具（如Git）、拉取評審和自動檢查，強制執(zhí)行“文檔即代碼”管道流程，讓整個團隊能夠像處理代碼一樣貢獻、評審和跟蹤變更。這種整合使得文檔創(chuàng)建和編輯過程更加流暢，提高了團隊協(xié)作的效率。

2、格式支持：Writerside支持Markdown和自定義的基于XML的標記，并允許文檔作者在同一文檔中組合這兩種格式。例如，作者可以向Markdown文檔中注入語義屬性。此外，Writerside還支持動態(tài)地將Markdown片段轉換為XML，并將它們導入到XML文檔中。這種靈活性使得文檔作者可以根據需要選擇最適合的格式，同時保持文檔的結構和語義完整性。

3、內置檢查：Writerside內置了100多種檢查，例如無效鏈接、缺失的資源、不正確的屬性值等。這些內置檢查可以幫助文檔作者及時發(fā)現并修復問題，提高文檔的質量。同時，Writerside還提供了預定義的設計，可以很容易進行定制，這樣文檔作者就不需要處理與布局和CSS相關的問題。

4、實時預覽：由于文檔作者需要編寫XML或Markdown，因此Writerside提供了一個實時預覽功能，可以立即反映每個更改并高亮顯示錯誤。這在無法訪問CI/CD管道或構建時間較長的情況下特別有用，可以在不等待輸出完成的情況下檢查輸出。

5、語言支持：Writerside還提供了一個基于人工智能的拼寫檢查器和一個由JetBrains構建的語法糾正器，支持超過25種語言。這使得文檔作者可以更方便地進行拼寫和語法檢查，提高文檔的準確性和可讀性。

6、可擴展性：Writerside既可以作為JetBrainsIDE插件使用，也可以作為獨立應用程序運行（Early Access Program （EAP） ）。這種可擴展性使得用戶可以根據自己的需求選擇最適合的使用方式。

常見問題

1、Writerside如何構建和發(fā)布文檔？

Writerside 允許您在本地構建文檔項目并生成。zip文件。然后，您需要將其上傳到您的網站或托管在GitHub Pages、Amazon AWS、Netlify 或任何其他托管服務上。我們正在考慮未來提供我們自己的文檔托管服務。

如果您使用 CI/CD 服務器，我們可以作為 Docker 容器提供構建器腳本，您可以使用這些腳本配置文檔構建。

2、Writerside源文件存儲在哪里？

您可以在本地存儲文件，但建議選項是使用 Git 倉庫。 為所有 Git 操作、管理分支和解決沖突提供了方便的 UI。您還可以使用其他受支持的版本控制系統(tǒng)，例如 Subversion 或 Perforce。

作為文檔工具，存儲是首先考慮的?？梢愿创a一樣方便的管理版本。

3、Writerside是否支持從其他格式遷移？

如果您有 Markdown 源，可以將其導入 Writerside 項目。我們還在推進從基于 XML 的格式（包括 DITA）的遷移。

更新日志

v2024.3版本

1、代碼示例

Writerside 現在可以在輸出的代碼塊中正確突出顯示所有受支持的編程語言，并建議它們完成lang屬性。

通過相對路徑引用帶有代碼的文件。

通過 導航到源代碼文件。

Writerside 現在可以正確處理帶有空行的代碼塊。

2、API文檔

您可以從 UI生成 API 參考作為新實例和現有實例中的新主題。

包含生成的 API 文檔的主題現在也有一個導航側邊欄，但默認情況下它是折疊的。

API 文檔現在可以搜索。

3、PDF導出

您現在可以生成 PDF作為構建工件。

您現在可以在生成的 PDF 中配置“目錄”標題。

修復了表列寬度、TOC 標題、工具提示術語和 deflist 排序的處理。

4、圖表

升級至美人魚版本11.0.2。

您現在可以從指定的片段目錄或通過文件的相對路徑引用圖表文件。

Writerside 不再剪輯多行美人魚圖節(jié)點中的部分文本。

Writerside 不再報告帶有圖表的代碼塊太寬。

5、其他修復和改進

Writerside 現在支持無邊框表格。請參閱border屬性。

現在，編輯器 |下的設置中有一個專門的 Writerside 部分。一般|代碼折疊可禁用 XML 主題的各種元素的自動折疊。

現在有一個裝訂線圖標可以從當前打開的主題導航到樹文件中的 TOC 元素。

對于 XML 主題，Writerside 現在顯示具有 ID 的元素的使用次數。這樣，您就可以知道某個片段被重用（包括在其他地方）或某個章節(jié)被引用了多少次。

Writerside 不再提及構建報告中被忽略的問題。

Writerside 現在顯示社交媒體資源鏈接的工具提示。

Writerside 不再產生起始頁面主題中缺失和阻塞的MRK023問題（這些元素不是強制性的）。MRK024<primary><secondary>

Writerside 現在可以正確生成REF007從現有 Web 文件名重定向的問題。

Writerside 不再為 Markdown 主題中的警告和代碼塊產生誤報重復 ID 錯誤。

Writerside 現在可以正確生成頁面規(guī)范。

睡眠模式后，實時預覽不再凍結。