jneo8.com

Search

Search IconIcon to open search

Build document with Diataxis-202402281733

Last updated Feb 28, 2024 Edit Source

# Build document with Diataxis-202402281733

# Summary

The thoughts for Diataxis

# Notes

Diataxis 描述了一種建構高品質技術文件架構的實做指南, 它可以有效地幫助我們發現既有文件的問題以, 提高文件的深層品質和使用者體驗, 對於我本人而言是某項缺失的能力

可能有很多人/本人有切身經歷是工程師不喜歡寫文件/工程師寫的文件品質/體驗很差, Diataxis 指導人們從使用者的需求/體驗出發去建構文件的架構, 風格. 對過往沒有系統性學習或思考如何寫出高品質文件的工程師來說是一個非常不錯的指南

我不想在這邊提及任何藏於其中的知識, 所以有緣人就自己看吧, 內容不會到太多大約 1~2天可以看完


# References

Diátaxis