文案
技术写作/用户文档
文档分类
- 流程文档 指导系统的开发、测试、维护和改进。经理、工程师、测试员和营销专业人士使用它们。这些文件使用技术术语和行业特定的术语。
- 产品文档 为客户提供使用产品所需的信息。它们主要是包括一些技术解释的教材。他们使用日常术语来代替技术术语，使新手或局外人更容易理解系统。
流程文档
对于大型软件项目，技术作者甚至在开发开始之前就开始准备文档。技术作家必须在SDLC期间制作不同类型的文件，例如：
- 测试计划
- 设计规格
- 项目计划
以下是提供系统开发和维护相关信息的流程文件：
- 估算、计划和时间表：经理通常准备此类产品文档，描述如何管理和控制软件。
- 报告：这些文件报告了开发过程中的资源使用情况。
- 标准和惯例：这些文件概述了如何实现流程需求。工作文件：这些是项目最重要的技术通信文件。工作文件记录了从事该项目工作的开发人员的想法和想法。他们解释了实施设计背后的基本原则。工作文件还描述了实施战略。
- 电子邮件和备忘录：这些文档包含经理和软件开发人员之间的通信。这些是软件历史学家的主要兴趣所在。
启动阶段缩进线项目提案营销研究可行性分析
分析和规划阶段
发展阶段
- 详细设计
- 代码注释
- 测试用例
- 版本控制记录
集成与测试阶段
- 自上而下的测试
- 自下而上的测试
- 混合（“三明治”）测试
- 大爆炸、风险最强等。
交付阶段
- 安装和维护手册（请参阅下面的产品文档）
- 培训交付
- 故障诊断和问题跟踪
- 发布说明（取决于方法）
维修阶段
- 更新和补丁
- 发布说明
- 故障诊断和知识库
改进阶段
- 项目会计
- 经验教训
产品文档
产品文档提供了有关产品的全面描述和信息。与流程文档相比，产品文档的使用寿命相对较长。技术作者在开发产品时开始准备产品文档。编写产品文档和开发产品是一个同时进行的过程。产品文档可以分为：
- 用户文档：用户文档是为最终用户编写的。它包含有关如何使用特定产品的详尽信息。
- 系统文档：主要面向系统和维护工程师。
用户文档
技术作者构建文档，使其适应不同的用户任务，并满足具有不同经验和专业知识的用户的需求。技术作者必须能够区分最终用户和系统管理员。
- 最终用户使用该软件来完成他们的工作。用户可以使用该软件编写书籍、管理保险单或驾驶飞机。最终用户对学习软件的复杂细节不感兴趣。他们只想知道如何利用该软件执行特定任务。
- 系统管理员为最终用户管理软件。系统管理员的工作可以是多方面的；他们可以在系统需要工作站网络时担任网络经理，如果是大型主机系统，他们可以担任运营商，也可以作为技术专家为最终用户解决软件问题。
用户文档的类型
技术作家为不同类型的用户准备文档。通常，用户文档有四种基本类型：
- 功能描述-功能描述列出功能，描述复杂的GUI，并提供有关系统所提供服务的信息。本文应提供软件的详细概述。最终用户应该能够在阅读介绍性手册后决定这是否是他们正在寻找的软件。
- 管理员手册
- 系统要求
- 安装-系统安装文档是为系统管理员准备的；此文档应提供有关如何安装系统的信息。系统安装文档应包含系统文件和所需硬件配置的说明。它还应该提供有关如何操作系统、如何自定义依赖配置的文件以及如何建立永久文件的详细信息。
- 配置-系统配置文档适用于系统管理员或用户。本文提供有关如何配置系统或软件以供最终使用的信息。您可以根据需求和信息量将此文档与系统安装文档相结合。
- 用户手册-用户手册应向受众介绍该特定系统。它应该概述系统的正常功能，并应该提供有关如何开始和使用各种应用程序的说明。说明应通过示例进一步说明。
- 系统参考-系统参考文档应提供有关系统设施、如何使用这些设施、错误消息列表以及如何从错误中恢复的信息。系统参考手册应以描述性风格编写。它为最先进或技术含量最高的用户提供详细信息。
专业化写作
专业名词
测试方法的概念真的好多，比如冒烟测试、单元测试、黑盒测试、白盒测试、灰盒测试、接口测试、回归测试、自动化测试、测试用例、余量测试、兼容性测试等等。
然后我就懵了。我只能一个一个去百度，查了后还担心百度不准确，还找测试同学验证下是不是这个意思。而现在回想起来，我能记住的大部分是本身名词就好理解的测试概念。而对我来说，比较难理解的，我始终没记住，比如冒烟测试，我至少查了三遍。
在一些比较偏技术类的产品中，专业名词是比较难完全避免的一件事，但是这并不代表没有办法去优化。比如加个解释
 |
专业名词加解释，用户可以明白名词本身所传达正确的意思，而不会被误导。毕竟网络上所查到的，不一定是正确，或者不是你想引导用户的。 添加解释，同样也是让用户的疑惑有出口，而不是迷失在茫茫的名词中。如果当前这个名词或是某个操作，需要更多的引导和解释，一两句话完全无法解释清楚，这时就需要加个文档链接，来让用户知道更具体的引导。 那加了解释后，是不是就万无一失了呢？
文案太冗长，抓不住重点
曾经用户只想要一个简单的理由，但你却写了三大段… 聊天中，大概大家都不会喜欢与啰嗦的人聊天，因为废话太多，而且还不停在重复。如果你看电视，你大概也不会想看情节拖沓的，看了快30集，男主还在女二身边徘徊，这心焦急的如同火烧。 解释的文案也是同样道理。如果写太长，用户会失去想看的欲望。长句也会增加用户的理解成本，到最后文案并没有发挥它该有的功用，可能不小心还误导用户。
因为是解释，所以更应该要直接明了，简洁有力。
用文字代替图标
在一些页面中，为了让整个页面看起来更加美观，会用图标的方式来表达一些操作或指导。一些常用的图标用起来，会相对来说得心应手，用户也能够理解。 但是在一些本身就比较少见或难懂的名词中使用图标来表达时，往往会造成用户疑惑。有时候费尽心思，熬尽脑力，终于画出一个让人惊艳的图标后，业务方却告诉你，他看不懂这是什么？ 这真是尴尬的时刻，但却很真实。人们对图标和对文字的理解，是两个不同的领域，一个是语言，一个是图形。曾经有一段时间，我很纠结，为什么指南针的图标，是表示「发现」， 不应该是方向么。 每个人对图形的理解都是不同的，如果一定要加上图标，那就图标+文字吧。
可怕的英文翻译，可怕的英文
我有个习惯，中文系统看腻了，会时不时地把系统语言换成繁体中文或英文。当我切换到英文时，经常会看到一些让我觉得尴尬的英文。要么就是中文式英文，要么就是一长段看着就像是机翻的英文，还有中英文夹杂的页面… 如果你的产品要做外语用户，请遵循外文的一些使用习惯。不然你的外语用户，会很痛苦…
退款发票处理
1、退款时是否要寄回已开具的发票？
已经开具的发票在广告主申请退款时需要将发票及相关文件一同快递回腾讯，分两种情况进行处理：
（1）广告主开具的是增值税专票
请确认您的增值税专票属于以下哪种状态：
状态一：发票未经过认证，且未超过有效期限
广告主需要提供发票原件、加盖公章或财务章的拒收证明。
状态二：发票已经认证，或者已经超过有效期限
广告主需要提供红字申请单（申请单上的金额与发票金额一致）、发票复印件，这两个文件都要加盖公章或财务章。
（2）广告主开具的是增值税普票
请您填写《增值税普票拒收证明》并打印、加盖公章，连同发票一同快递到腾讯。
2、如果发票丢失，无法寄回发票怎么办？
（1）如丢失的发票是未认证抵扣的专票或者是增值税普通发票，广告主需前往税局办理发票丢失并申请处罚证明，再将罚款证明加盖税务公章+公司公章，并寄回至腾讯公司。 （2）如丢失的发票是已认证抵扣的专票，请广告主在退款申请表中写明情况即可
视频格式转换
工具/原料
- 电脑
- VLC
方法/步骤
打开VLC，点击左上角的【媒体】，选择【转换/保存】。
在”文件“选项卡页面，点击右侧的【+添加】按钮，选择源视频，然后点击页面下方的【转换/保存】按钮。
在”转换“设置页面，在”配置文件“右侧的下拉菜单中，选择转换的目标格式；我这里选择常用的H.264 MP3格式，也可以选择VP8、H.265、WMV等其他格式；在”目标文件“右侧点击【浏览】按钮，选择转换后的视频保存路径，然后点击【开始】。
视频转换过程中，VLC顶部会显示”Converting file:///+文件路径+文件名“，底部会显示转换进度。中文名称不会直接显示。
视频转换完成后，关闭VLC即可。在设置保存的路径下，可以看到转换后的视频，双击视频文件，即可打开播放。也可以通过MediaInfo （Mac / Windows）工具查看转换后的视频相关参数信息。
默认情况下，转换前后的视频分辨率是一致的。
在设置视频格式页面，点击下拉菜单右侧的设置按钮，可以进行更多详细的设置。
品牌化
制造楼层的数字黑暗使工厂管理失明
工厂经理在开始新的一天时对白天会发生什么几乎没有可见性；既不知道当天的生产力是什么，也没有洞察他们一天中将遇到的潜在限制。因此，工厂管理层对潜在风险视而不见，主要对情况做出反应。
维护部门充斥着纠正和紧急维护工作订单，即使他们虔诚地遵守推荐的预防性维护时间表，因为他们缺乏预见机器状况并相应采取维护方法的能力。
在数字黑暗工厂中，质量工程师对迫在眉睫的质量问题一无所知，因此只有在发生质量拒绝时才能处理问题。制造工程师缺乏改进流程的信息。当然，设施经理也处于不利地位，缺乏洞察力，无法有效实现能源和公用事业消耗。
最重要的是，总经理也因缺乏车间的数字洞察力而受到阻碍，因为他做出了重要决定，导致决策不理想，成本更高，失去机会，投资和资产回报率低。
今天，制造商有更好的工厂管理的替代品。通过数字可见性改造车间有可能提高生产率、降低成本和提高资产回报率。
通过数据洞察力获得视力
今天的生产机器和自动化系统生成了很多有用的数据。在离散制造工厂中，大多数自动化系统都有每个流程步骤的端到端周期时间数据。大多数控制器被编程为在出现异常时引发故障和警告事件。一些控制器甚至捕获参数数据，如扭矩、电流等。机器人手臂上的位置信息是机器人控制器生成的另一组数据。计量设备捕获非常有用的质量测量。大多数公司都会跟踪生产率数字、维护活动和质量检查报告。
因此，大多数时候的挑战不是没有数据，而是收集、组织和分析数据以创造洞察力的能力。如果上述数据可以汇总、模式和相关性分析并理解，那么它就会揭示机会，警告未来的陷阱，并揭示最佳决策。
数字可见性方面：描述性、预测性、规范性和认知性
数字可见性有三个方面。首先是描述性洞察力，对当前和过去数据的简单可视化为改进提供了机会。第二个方面是预测洞察力——使用过去和现在的数据来预测工厂流程和机器的未来行为。第三个方面是规范性洞察力，即处理过去、当前和预测信息的能力，为工厂员工规定可操作的建议。第四个也是最后一个方面是认知洞察力，其中从原始和衍生信息中获得的情报用于建议工厂员工提供决策支持。可见性的这四个方面在下面的4个示例用例中进行了解释。
通过流程可见性提高目标生产力
端到端流程周期时间数据的数字可见性为优化流程、从资产中挤出更多内容和提高生产率提供了宝贵的机会。在某些情况下，离散制造工厂能够通过优化流程从同一生产线获得20%的产品数量；好处不仅是提高生产率，而且是增加资产回报，从而为增加产能节省资本。周期时间可见性的另一个好处是确定能源优化的机会。智能交错电机和驱动器启动优化了能耗。
通过预测分析提高整体设备效率（OEE）
图1 - OEE受到3大损失的影响
整体设备效率（OEE）是工厂管理层用于评估工厂和工厂设备生产力的关键指标。OEE受到3个关键损失的影响；（a）停机损失——当机器意外停机并停止生产时（b）质量损失——当生产不良部件时，减少总产品数量（产量）并增加废料（c）速度损失——当生产线或设备因瓶颈、机器故障甚至手动进料速度较慢而没有生产目标部件数量时。当发生此类损失时，生产的部件总数低于目标，OEE会降解。工厂管理的目标之一是减少这3个损失。
为这些损失带来可预测的可见性，使工厂管理层能够及早采取行动，避免这些损失的发生。想象一下，经理甚至在轮班开始之前，就能看到在仪表板上达到目标OEE的概率。如果仪表板显示OEE有70%的概率为60%，他或她可以找出为什么预测如此之低，以及哪些潜在行动可以减轻导致业绩不佳的风险。
假设工厂经理问轮班主管，为什么整体设备效率从88%下降到60%。作为回应，班主任能够提供准确的信息——二号线、14号站很可能在班次中途下降；18号站生产不良部件的可能性很大；或者一号线由于操作员效率低下而会比预期的要慢。工厂经理有能力实时查看正在发生的事情和尚未发生的事情，可以与轮班主管合作，采取积极主动的行动并保持OEE。
通过规范性建议和数字验证采用有针对性的维护方法
图2-转换为有针对性的维护方法
由于能够预测设备运行状况、停机和缺陷，维修工程师现在可以采用有针对性的维护方法，而不是简单的预防性维护方法。维修工程师在仪表板中查看推荐维护的设备列表以及关键性和优先级。规范分析功能用于将概率数字转换为特定的维护建议。即使是推荐的维护计划也可以作为规范性分析的一部分生成。现在，维修工程师可以要求主管创建适当的维护工作订单。一旦维护工作完成，数字可见性可以通过提供真正的闭环定向维护系统来自动验证在自动关闭那里的工作订单之前执行的维护任务。因此，工厂可以实现零停机时间，并节省备件和维护费用。
通过认知洞察力支持决策
汽车装配厂由数百个生产零件的一级提供服务，然后及时供应这些零件，以便在工厂更广泛的制造装配过程中使用。现实情况是，通常有数百家制造工厂合作，共同生产那辆卡车，该卡车的时速为60-76辆。
在这种情况下，当工厂线路因问题而停止时，工厂经理希望导致中断的任何事情都能尽快解决，因为当一条线路停止时，其他99条供应“准时”的线路也会停止。突然间，可能有数百人坐在那里等待决定。
想象一下，认知顾问就停止线路的最佳时间与减速的最佳时间向工厂经理提供建议的能力，根据基本条件提前停机的持续时间。工厂和99个一级可以有效地利用这一点来规划他们的劳动力；可以宣布提前吃午饭，而不是不假决定地等待一个小时。这种及时决策的成本节约可能是巨大的。每天都会做出这样的运营决策，这有助于降低运营总成本。
IBM工厂性能分析为工厂地板带来了数字可见性
图3-IBM工厂性能分析概述
IBM Watson物联网平台为工厂地板带来了数字可见性。IBM Plant Performance Analytics（PPA）是2016年10月发布的新的制造解决方案。该解决方案旨在预测影响整体设备有效性的约束，并规定补救措施，并为决策带来认知洞察力。该工具有助于工厂经理、制造工程师、维修工程师和质量工程师积极主动，并尽早采取行动，避免OEE的损失。
IBM工厂性能分析将工厂地板数据转化为可操作的见解，有助于提高生产率和降低运营成本。IBM PPA从生产机器收集数据，如周期时间、位置信息、参数数据以及故障和警告事件。设备主数据和来自企业资产管理系统、质量管理系统的交易数据也进行了集成。PPA对这些数据进行高级分析，以提供对生产站和生产线的预测性洞察力、描述性和规范性见解。
预测洞察力
PPA仪表板提供了可视化即将到来的班次预测可用性、性能和质量指标的简单方法；这可能适用于线路、特定工厂区域、车站或整个工厂。您可以深入到特定资产，以找出预测的根本原因。一旦您深入到特定站点或资产，您将能够找到详细的预测——事件发生的概率是多少，事件发生的可能时间是多少，可能的原因是什么，缺陷或失败是什么。从历史上看，如果发生这种情况，需要多少时间才能恢复。这揭示了影响工厂生产力的最关键的潜在危险
描述性洞察力
这种能力与分析预测的能力有关。哪些参数导致预测？多久发生一次？对下游运营有什么影响？预测是正确的还是统计异常？
规范性见解
一旦做出了关键或“热门”预测，PPA就有一个优化模型，可以推荐最佳行动方案。考虑到当前的生产计划和维护计划，维修机器的最佳时间是什么时候？;如果没有零件，对OE有什么影响？安排维护的下一个最佳时间是什么时候？缓解关键质量预测的最佳流程设置点应该是什么？线路速度对整体OE有什么影响？
PPA将这些价值作为软件即服务提供。通过高级分析，我们看到植物OE提高了5%以上，运营成本降低了7%以上。
代表工厂运营的分析模型和信息
PPA包含基于ISA-95标准的信息模型，因此能够代表任何制造操作。PPA可以捕获工厂组织，了解车站、车站内设备和支付点之间的关系，从而能够现实地预测车站、线路和车间的性能。
还包括专门为生产运营构建的行业分析模型。例如，焊接站模型捕获机器人、焊接附件和夹具的行为，这些机器人、焊接附件和夹具在焊接站中一起工作，以提供工作站性能预测。这些预建模型大大缩短了项目启动时间，并提供了现成的内容。
该解决方案附带专注于植物角色的移动友好应用程序。例如，工厂ME应用程序专注于停机预测、分析和维护建议。
认知能力如何在优化过程中使用？
在许多组织中，主要重点是优化有助于预测风险的运营和预测能力。但认知呢？为什么它如此重要？之所以重要，是因为大多数可用的预测能力都是战术性的。它是数字——基于概率百分比的警报，将注意力引向将在一段时间内发生的潜在错误。这些是工厂经理或员工的战术数字，他们可能没有能力将其解释或同化为原始数据。正是沃森的认知能力处理这些预测及其描述，将其转化为可操作的步骤，现场人员或工厂经理可以轻松吸收、理解和采取行动。
在哪里可以找到其他信息：
了解有关IBM制造解决方案物联网的更多信息。