技术白皮书:如何写一篇

时间:2009-02-02 09:31:07

标签: documentation

伙计,

研究和展示技术白皮书的最佳方法是什么?我不是指格式,概述,部分和类似的东西。

我从来没有写过 - 我想知道白皮书是否需要非常非常通用(概念)或具体(例如支持特定工具/方法)

如果你的回答有利于通用方法,我想知道如何研究它。是否更好地关注较小的用例场景,从小做起,使用特定的工具/方法,获得良好的理解,然后进行更多研究并开发关于该主题的广角视图?

6 个答案:

答案 0 :(得分:10)

是的,尝试阅读其他技术白皮书。但是,不要只阅读任何白皮书。阅读更好的。你可以通常确定哪个是“更好”的,通过检查论文被引用的次数(我去的一个网站是cite seer和谷歌学者)。一些一般准则是:

  1. 尽量直截了当,不要绕过灌木丛。
  2. 始终如一地使用您的首字母缩略词。
  3. 借此机会陈述以前方法的弱点,因为它表明你已经努力审查/调查其他方法。
  4. 技术论文需要非常具体。准确说明你的方法如何运作,准确说明你如何进行实验(以便其他人可以复制你的实验),准确陈述你的发现(很多图表会很好),最后用40-60个字左右来结束。
  5. 强调新的东西(你提议的东西)而不是旧的东西(那将是你的背景)。区分清楚。
  6. 通常,您不会在论文中包含源代码。如果必须,请在网页上与论文链接一起发布。
  7. P / S:我的建议有点偏向学术论文。但我认为它应该适用于你的情况。

答案 1 :(得分:7)

白皮书的目的通常是提倡特定的观点或提出问题的具体解决方案。

但是,如果您的白皮书仅仅是营销或销售宣传,那么您就不会做出非常好的案例。传统的建议是,您必须首先阐明您的受众的需求(商业化中的“痛点”)并解决您的需求。

答案 2 :(得分:3)

这听起来有点无益,但白皮书有各种形式,从非常具体到非常一般。确定最终目标是什么。您是在尝试销售某些东西,还是描述新技术小部件的工作方式,还是描述体验?此外,确定您的受众是他们的业务,技术,家庭等。

看一看例子 - 大多数大公司(IBM等)在他们的网站上有数百个。阅读一些内容,看看有什么打击你的优点和缺点。

答案 3 :(得分:1)

我的0.02:

阅读一对,并尝试让思维导图试图想出它们的样子。

完成此分析后,请返回并选择白皮书所需的部分。特别是,使用您的文档结构构建 ANOTHER 思维导图。

数据也是传达信息的重要方式。因此,在绘制数据图表之前,请先考虑一下数据可视化技术。

答案 4 :(得分:1)

白皮书可以是一般性的,也可以是非常具体的。这完全取决于主题,观众和意图。

例如,一篇关于R + D主题的论文,或者在学术界提出的论文,或者旨在提供未来某些工作的概念草图的论文将以更加被动的语言写成,几乎是Q + A格式。讨论。你可能会提出多种想法,可能会在没有达成一个固定结论的情况下赞成它们。

关于特定技术的白皮书,为了客户的澄清利益,或说明或记录某些结果,将非常坚定,固定并得出明确的结论。号。

你唯一可以说的是这个过程是模糊的 - >具体

答案 5 :(得分:1)