问HN:你们会打印软件文档吗?如果会,你们是怎么做的?
我怀疑如果我能在电脑之外进行更多的工程工作,我会更加专注,工作效率也会更高。因此,我正在考虑将我的工作流程中的某些方面转为模拟方式。我在考虑打印文档并将其放入三环活页夹中,但我希望能听到其他有类似经验的人的见解。
到目前为止,我的计划是:
1. 收集某个项目的关键文档(包括语言、API等)。
2. 选择要打印的文档内容。以Elm语言为例,我不需要打印每一个包的文档,只需打印我在项目中使用的那些。
3. 清理文档,使其适合打印。我对Elm语言进行了试运行,意识到这将是一个繁琐的步骤,但如果做得好,应该能减少纸张浪费,并使文档更易于导航。
4. 打印。
5. 将文档整理到不同的三环活页夹中,并加上标签,以便于导航。例如,我会为Elm准备一个活页夹,为后端语言准备一个单独的活页夹,以及为其他杂项准备一个单独的活页夹。
我知道这些文档会过时,而且我怀疑像React和HTML这样的文档由于数量庞大而难以整理。我主要是一个网页开发者,这些技术似乎比其他技术更新得更快,这意味着它们过时的风险更高。
因此,虽然“打印文档”听起来很简单,但随着我开始深入思考,这似乎比我想象的要复杂得多。我非常希望能听到这里任何人的见解,包括关于此的博客参考,尤其是是否已经存在提供这种服务的公司。
查看原文
I suspect that I would be more focused and work better if I did more of my engineering work away from the computer, so I'm looking at aspects of my workflow to make analog. I'm considering printing documentation and putting it in a 3-ring binder but I would appreciate insights from others who have done this.<p>So far my plan is<p>1. gather the vital documentation for a given project (including language, apis, etc)<p>2. choose which aspects of the documentation to print. Let's use the Elm language for example, I wouldn't need to print docs for every single package just the ones I'm using in the project.<p>3. clean up the documentation so it is print-ready. I did a dry run for the Elm language and realized this would be a tedious step but doing it well should result in less wasted paper and easier-to-navigate documentation<p>3. print<p>4. collect into separate 3-ring binders with tabs to make navigation easier. For example I would have a binder for Elm, a separate binder for the backend language, a separate binder for miscellaneous<p>I know that these will get out of date, and I suspect some documentation like React and HTML will be difficult to curate due to the large volume. I'm primarily a web developer and these technologies seem to move faster than others which means the risk of them getting outdated is higher.<p>So while "print out documentation" sounds simple enough, as I've begun thinking it through it seems more complicated than it should and I would love any insight anyone here has, including any references to blogs about this, and especially if a service already exists that does this sort of thing