TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

The Seven-Action Documentation Model

96 点作者 theletterf4 个月前

3 条评论

asdfman1234 个月前
&gt; A solution to this situation is shifting the focus from what should be written to what user needs should be addressed<p>This goes for all forms of communication, all the time. Whether you&#x27;re writing or speaking or having an informal conversation, relentlessly focus on your audience: what they think, what they know, and what they need to hear.<p>Think hard about your audience, and then think about them again.<p>Oh, also my soapbox topic is all documentation should have a line at the top explaining it like you&#x27;d explain it to your parents. &quot;This cli tool was built in order to automatically run all tests in the suite, instead of manually like before.&quot; Etc.
评论 #42649379 未加载
评论 #42649952 未加载
adolph4 个月前
Link going next to Diataxis [0] in my bookmarks.<p>0. <a href="https:&#x2F;&#x2F;diataxis.fr&#x2F;" rel="nofollow">https:&#x2F;&#x2F;diataxis.fr&#x2F;</a>
评论 #42648128 未加载
hitchstory4 个月前
&gt;Engineers dabbling in documentation and feeling lost as they approach the field, on the other hand, are drawn to docs frameworks because frameworks are all they’re used to working with<p>Im drawn to frameworks because without them I cannot implemented an automated way to address the problem of docs going out of date.
评论 #42650922 未加载
评论 #42649419 未加载