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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Improving documentation of open source software

77 点作者 felicianotech大约 6 年前

6 条评论

ken大约 6 年前
I actually like writing documentation, even if I&#x27;m not great at it yet, but I struggle to be able to do this well for other people&#x27;s software. I feel that project documentation, to be done well, has to be part of the project itself.<p>Half the time I start writing documentation for a feature I&#x27;ve built myself, I go back and rework the design based on what I learned from trying to document it. It&#x27;s rather enlightening to write &quot;Here&#x27;s how to do this thing that you&#x27;ll do 100 times a day...&quot;, and then discover to your horror that it takes 14 steps. Oops.<p>And when you try to document the <i>why</i> and <i>how</i> of most open-source projects, it very often comes down to &quot;historical accident&quot; and &quot;it&#x27;s like some other ancient system you&#x27;ve probably never used either&quot;. There&#x27;s a lot of features where I&#x27;d just write &quot;This next dialog box is useless, so just hit return&quot;, or &quot;This thing you have to type is completely nuts, so just memorize this nonsense&quot;.<p>I believe that&#x27;s why third-party documentation (O&#x27;Reilly books, The Missing Manual series, etc) is so successful. It&#x27;s a lot easier to write (tactfully) &quot;This is dumb, so here&#x27;s how you get past it&quot;, than to go back and fix the feature. And nobody wants to write documentation about their own software that says &quot;Yeah, I know this thing you have to do here is dumb, but hey, it&#x27;s only a 1.0 so please don&#x27;t hurt me.&quot;
评论 #19255507 未加载
评论 #19254834 未加载
评论 #19255093 未加载
forsaken大约 6 年前
Love docs? Check out <a href="https:&#x2F;&#x2F;www.writethedocs.org" rel="nofollow">https:&#x2F;&#x2F;www.writethedocs.org</a> — conferences in 3 continents and meetups around the world. Also a slack community for more real-time docs talk.
评论 #19252774 未加载
Hamatti大约 6 年前
Hey! Original author here, excited to see open source documentation brought up in Hacker News.<p>I feel like documentation in general is a topic we developers don&#x27;t talk about enough and it&#x27;s often cast aside as a &quot;we&#x27;ll do it if there&#x27;s time&quot; and I think we all know there&#x27;s never gonna be &quot;time&quot;.<p>If you wanna set up similar things with your colleagues or local community, feel free to hit me up (email in bio) or ask here and I&#x27;m more than happy to share ideas and how we made it happen.
softwaredoug大约 6 年前
In addition to docs, I’d also add evangelism as often missing. For a project to be successful, someone fronting the project and engaging with a potential community on how it could be used. Call it “sales” or “marketing” even, but open source projects need it as much as proprietary products...
评论 #19250896 未加载
评论 #19250958 未加载
评论 #19252050 未加载
_bashskids大约 6 年前
Isn&#x27;t it that what we need is an authoritative wiki?<p>With one or more pages per piece of software, depending on complexity.<p>Eg: when you have to know how to cut videos from time1 to time2 using ffmpeg but not much time for reading man pages, such a wiki with tutorials would be of great help.<p>For ffmpeg, of course, you can find some blog, but not in case of all software.
secfirstmd大约 6 年前
That&#x27;s cool. We interact with as many communities as possible but sometimes it&#x27;s hard to know if people find our documentation useful
评论 #19254342 未加载
评论 #19253436 未加载