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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

We fixed our documentation with the Diátaxis framework

61 点作者 _acco5 个月前

4 条评论

iamwpj5 个月前
Hey, nice work. I think dedicating time and effort to documentation pays off in years to come.<p>Also -- from your original plug about your product I would have ignored it, but after reading through some of the docs, I actually see some use cases for this in a couple of upcoming projects!
kaycebasques5 个月前
What I&#x27;m about to say is a big topic that&#x27;s probably better suited as a blog post, but I&#x27;ll try anyways.<p>I think Diataxis is a valuable aid for <i>thinking</i> about documentation strategy but is not always necessarily a literal blueprint. I.e. when determining whether you have completely documented an area, it&#x27;s very valuable to ask yourself &quot;do we have tutorial content for this area? Explanations? References? Guides?&quot; but it doesn&#x27;t necessarily mean that the tutorial and explanations need to literally be on different pages.<p>We tried adopting Diataxis on pigweed.dev [1] as a literal blueprint and it resulted in too much fragmentation. E.g. the explanations for a Pigweed module were on one page, but the tutorial was on another. Users and teammates found it annoying to have to jump back-and-forth so much. In my mind, I still use Diataxis as an internal checklist of sorts, but I don&#x27;t necessarily require the content to be split across different pages. E.g. sometimes the most natural&#x2F;effective place to put an explanation is in a tutorial, when the user is getting hands-on experience with that topic. You reinforce the theoretical foundations with the direct experience and vice versa. If you only link to explanations from the tutorial, some (most?) users won&#x27;t click those links, and therefore may never get exposed to the theoretical foundations. For some areas that&#x27;s OK; for others it&#x27;s could be a disservice to the user. It depends strongly on what you&#x27;re documenting.<p>I believe I have discussed this with Daniele on the Diataxis channel in Write The Docs Slack [2] and they responded that this is why they call it <i>modes</i> of documentation.<p>That said, these recently updated docs [3] reflect our general approach to Pigweed module documentation [4]. You can see that we still do often split our docs clearly along the lines of references&#x2F;guides&#x2F;explanations&#x2F;tutorials.<p>The other big limitation of Diataxis IMO is that I&#x27;m not sure if the map [5] really is a comprehensive way to think about documentation. (As I&#x27;ve said in previous HN discussions about Diataxis) How do homepages and READMEs fit into the map, for example?<p>That said, the world&#x27;s documentation is much better off thanks to Diataxis. The fact that it gets discussed a few times every year here on HN is a great service because it makes the task of improving documentation much less daunting and much more straightforward, and provides very focused discussion on how to improve documentation strategy in general.<p>Update: I think [6] is a newer document (published Aug 2023) that has been added to cover the complexities I mentioned in this comment. This page was not on my radar.<p>[1] <a href="https:&#x2F;&#x2F;pigweed.dev&#x2F;seed&#x2F;0102.html" rel="nofollow">https:&#x2F;&#x2F;pigweed.dev&#x2F;seed&#x2F;0102.html</a><p>[2] <a href="https:&#x2F;&#x2F;app.slack.com&#x2F;client&#x2F;T0299N2DL&#x2F;C02149LN2HJ" rel="nofollow">https:&#x2F;&#x2F;app.slack.com&#x2F;client&#x2F;T0299N2DL&#x2F;C02149LN2HJ</a><p>[3] <a href="https:&#x2F;&#x2F;pigweed.dev&#x2F;pw_rpc&#x2F;" rel="nofollow">https:&#x2F;&#x2F;pigweed.dev&#x2F;pw_rpc&#x2F;</a> for on example, <a href="https:&#x2F;&#x2F;pigweed.dev&#x2F;pw_async2&#x2F;" rel="nofollow">https:&#x2F;&#x2F;pigweed.dev&#x2F;pw_async2&#x2F;</a> for another<p>[4] I&#x27;m well aware that some docs on the site are in bad need of an update, so please don&#x27;t grab some random page from the site and tell me that the pigweed.dev docs suck and therefore everything I say is invalid<p>[5] <a href="https:&#x2F;&#x2F;diataxis.fr&#x2F;map&#x2F;" rel="nofollow">https:&#x2F;&#x2F;diataxis.fr&#x2F;map&#x2F;</a><p>[6] <a href="https:&#x2F;&#x2F;diataxis.fr&#x2F;complex-hierarchies&#x2F;" rel="nofollow">https:&#x2F;&#x2F;diataxis.fr&#x2F;complex-hierarchies&#x2F;</a>
评论 #42341485 未加载
评论 #42341650 未加载
ChrisArchitect5 个月前
Related:<p><i>Diátaxis – A systematic approach to technical documentation authoring</i><p><a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=42325011">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=42325011</a>
cbsmith5 个月前
I always want to jump right to the explanation documentation. The rest of it seems like a waste of time (well, the Reference bit can be somewhat useful later). I find tutorials and HOWTOs as misleading at best.
评论 #42341916 未加载
评论 #42341479 未加载