几个月前，我在一家开发无损检测实验室管理系统的初创公司中完成了自己的职业生涯，成为一名多臂湿婆神。 我将告诉您如何记录与扩展连接和生成文档有关的部分开发工作，以便进一步静默使用已创建的系统两年。
我将尽力为读者提供有用的材料，同时注意项目的利益，而不是透露实施和内部使用的细微差别。
鉴于：
- 很酷的开发团队，当然还有项目经理。 在项目开始时，我在托木斯克的一家工作室担任艺术总监，然后我加入了创业团队
- 特定事件的钢筋混凝土日期启动-FRII中的加速启动
- 初始模板集来自一个文档中具有不同连接条件的15个文档，这些文档的大小从1页到100+页不等
- 应该与将来的解决方案集成的第三方项目
- 设计师（分析师，设计师，设计师，艺术总监，产品负责人，产品经理全部合为一体）
挑战：
- 准时启动项目
- 六个月后，在连接新功能以及系统中甚至更多文档时，也不要死于团队混乱（如果成功完成了加速）
- 用最少的字母和花费的精力来获得合适的文档
- 将文档移交给任何不在上下文中的团队/任何员工
我必须马上说，以下文档模板是在没有任何方法的情况下制作的，我仅受项目细节，常识和可怕的时限的指导。
分析与准备
我希望您从对材料的分析开始任何不平凡的任务，在我的情况下，该材料是文档模板和需要与之集成的现有项目。 但是，我们只是在谈论文件。 我需要确定在同一文档内以及文档之间使用相同类型数据的频率。 有必要了解现在是否需要一个系统，或者您可以先在膝盖上快速进行操作，然后再处理结果。 当时，我们决定需要该系统，因为在一个文档中以及整个文档包中都重复了一个或多个卷中的几乎所有数据-这无疑是第二或第三文档在连接时出现混乱的迹象。
下一步是了解文档标记的清洁状态。 我会解释。 事实是，我已经从方法学家那里收到了已经完成的文档模板-即使我知道这样做所能提供的帮助，他们也不知道何时，如何做这些文档。 内的.docx文档类似于xml的文本，某些元素在打开的文档中可能看不到，但会出现在文档的标记中。 尚不知道文档生成器和用于查看文档的各种软件将如何对这些标记元素做出反应。 主要赌注是在Microsoft Word上，但是有OpenOffice，LibreOffice，并且所有这些都可以给出不同的结果。 因此，所有模板首先都要经过样式清理过程-完全重置任何设计，然后重新调整文档样式，并在某种程度上调整文档的结构。 甚至在执行此过程之后，我们在生成文档后仍会收集到问题。 将来，我得出的结论是，如果文档很小，则最好从头开始对其进行重新排序，而不要将方法学家提供的模板投入工作，这样可以节省多达5页的文档时间。 没有人愿意寻找原因，调试这些案例的过程对团队来说非常繁琐。 在同一阶段，如果您有一包文件，则使用统一的视觉语言。
而且由于我们进行了一次文件清洁的仪式，因此元信息中的复活节彩蛋本身就很值得推荐，因为人们喜欢共享优质的文件
在完成所有与文件准备有关的工作之后，我开始标记文件以自动生成。
文件标记
在此阶段，向开发人员询问支持团队选择的文档生成器的可变格式，以便您以后不必重做。 我不得不重做，但这是由于更换了发电机。 新生成器无法使用以前格式的变量，但是新生成器的功能对我们而言更为重要，因此我们决定替换它。
检查系统中信息的充分性，确定多少数据不足以容纳文档。 该数据什么时候应该出现在系统上？ 如果没有足够的数据来满足文档的自给自足，最好将其推迟。 什么是文件自给自足？ 在我的案例中，我们分三个阶段完成了一份文档，但是对于一个特定的方案，它可以立即自给自足，但没有涵盖其余的方案，因此我们决定推出该文档进行销售，留出空白单元格供用户填写未发现的方案，然后以必要的功能外观完成文档。
变量和接口文档
在注释的开头，我写道我们严格限于特定事件。 最重要的是，我已经计划好放假了。 当我不可用时，但是我急需添加一个系统变量（在最终用户界面中不可用），开发人员自己添加了带有变量的行，然后添加了缺少的条件。 在这方面，变量的说明并不能伪装成正确和理想的，但它是一个很好的工作文件，随后得到了扩展和发展。 从项目开始时和我离开项目时起，文档中的主选项卡在结构上都没有更改。
模板“
这些字段的规范 ”，可以在工作中使用和使用。 在文档中，我保留了部分数据作为示例。 该模板可能适用于接口文档，以控制开发质量。 例如，产品负责人知道他将获得什么最低要求，开发人员清楚地从这些字段的任务描述+规范中了解了要求达到的最低要求，并且如果他遗漏了一些东西，测试工程师会清楚地看到明显的情况。 最后，一切都变黑了。
首先，该文档将花费大量时间，但随后将为您节省大量时间，并且更新有时会花费几分钟。
内容：
- 该页面为在项目范围之外的人提供了指南。 对于团队中的新成员或项目外包很有用。
- 栏位名称
- 栏位类型
- 项目中的必填字段（我想提醒您，我们有另一个项目的数据库）-一个标记，用于同步文档和界面之间的绑定要求。 如果文档中的信息具有约束力，并且系统无法以其他方式接收到该信息，则必须在界面中将该字段设为必填
- 字段掩码-法规文件中明确定义了用于记录信息的格式。
- 预设值
- 字段中的最大字符数
- 字段可伸缩性（取决于分辨率）-根据分辨率描述接口元素的行为
- 数据需求-允许与界面元素进行哪些交互，以及可以进行哪些交互
- 成功样本
- 占位符-界面元素内用户的工具提示
- 字段的自定义-非标准界面元素或完成的任务
- 字段旁边的其他信息-当由于文本量而无法使用占位符时，我们将使用工具提示或句柄
- 验证类型
- 验证消息-系统条件和响应
- 文档模板中的变量-将插入文档模板中的内容
- 链接到页面-结果未使用
- 界面中字段的位置-结果未使用
文档连接文档
要由最终用户接收文档，仅对其进行编辑和标记是不够的；仍需要正确连接文档。 如果您具有相同的模板，则取决于条件来更改其内容，这一点尤其重要。 为此，我使用了一个单独的文档。
模板“
文档连接 ”，希望对某人有用。
内容：
- 状态-指示系统中文档的当前状态。 我们分三个阶段连接了一个文档，该文档的状态为“完成”
- 文档-团队，知识库以及我们的文档和任务设置系统中的文档名称
- 型式
- 文档格式是指同一文档可以使用不同的模板时，取决于该文档所对应的法规和技术文档
- 格式-一个文档可以只是一个变量被简单替换的模板，或者从3页的模板中可以获取100多个页面的文档-动态文档
- 程序包中的状态是系统的功能，您可以获取文件包或单独下载文件
- 可用性条件-包中是否存在特定文档
- 连接功能是文档中不在模板中且受代码约束的那部分。
- 链接到文件以进行连接
- 单独下载
- 要下载的文件的名称-系统中的文档可以随意命名，但是最终用户在下载时必须看到一个特定的名称
合计
结果，我在两个文档中都填写了362行。 令人印象深刻的音量？ 但实际上，这是30多个文档模板，并且一个人在两年（1-1.5周）内总共花费了40-60个小时的时间，其中不包括模板本身的编辑和连接任务的措辞。
该项目成功通过了IIDF的加速，并形成了自己的开发团队。 多亏了现有的文档，新团队的成员不必花很长时间去研究在生成文档之前所做的工作。 所有团队成员都可以随时访问关联文档的当前状态。
文档生成过程的文档编制的主要阶段：
- 分析文件内容
- 文件卫生
- 与文档标记并行修复变量
- 修复连接文档模板的细微差别。
感谢您的结束。