本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- LibreOffice
- 技术文档工程师:
- 克雷扎伊罗
- 项目名称:
- Calc 函数参考和用户指南
- 项目时长:
- 标准时长(3 个月)
Project description
项目请求
在技术写作阶段,我每周能轻松投入 30-35 个小时,在写作前阶段投入 10-12 个小时来学习项目所需的技能。我想要通知您,我目前住在我家的大学(在我所在的国家/地区),我可以使用快速的互联网和完成项目所需的任何插件资源。由于新冠肺炎疫情已经开始,我会在大学继续学习整个项目 因为目前情况不快,我所在的大学不能马上开始,即使这样,我也有可能在最后一年中不上课,因为我应该只花 5 个小时去上课。
简介
LibreOffice Calc 拥有大量(超过 500 个)函数列表,涉及许多类别的函数,这些在“帮助”中的文档并不详尽(但仍然准确)。Calc 的内置函数向导还会向用户提供有关每个函数的用途和参数的摘要信息。文档基础的 Wiki 上已经创建了一个结构,用于捕获有关 Calc 函数的更详细参考信息。
目标
为了通过为 Calc 的每个函数编写更详细的内容来填充 Wiki 结构,标记遵循 ODFF 标准(包括插图和图表)非常有用,并且提供了一两个示例来说明极端情况和例外情况,并提供示例/示例文件。
项目工作计划
我已经充分了解了这个项目的核心理念,实质上是在函数向导中记录每个函数的工作机制,并为每一个函数提供充分的示例,以涵盖函数的所有方面,并尽量让文档直观明了,以便新用户在几秒内就能了解其使用方法。
我可以考虑按类别来划分这些函数:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
每个函数都包含大约 20-50 个函数,还有几个类别包含更多函数。其中大部分都包含一个带有语法的浅层说明和一个示例。
我想为 Calc 的每个函数添加更详细的内容,标记对 ODFF 标准的遵循情况(包括任何有用的插图和图表),提供一两个示例以备注的形式指出极端情况和异常,并提供示例/示例文件。同时在任何有用的位置添加重要部分。 我会考虑以分类形式介绍这些函数,例如先选择一个类别并垂直开展工作,然后在技术文档撰写期间转移到另一个类别。除此之外,我还会考虑在社区凝聚期适应工作环境,让写作阶段的工作变得更加轻松。以我的经验,发现记录此类应用时会遇到的许多小问题需要投入时间。在规划方面,一开始我会针对这 11 个类别开展项目,当然,有些项目需要更多帮助,因此需要的时间比其他项目更多,但这些工作可以在工作中解决。由于现有的一些文档已经存在,而我正通过这些文档撰写相关文档,因此我会在每周的任务完成后考虑进行校对,因为上周不做修改并不好。
下面列出了在时限内组织该项目的大致安排。
- 第 1 周:(9 月 14 日) • 数据库
- 第 2 周:(9 月 21 日) • 日期和时间
- 第 3 周:(9 月 28 日) • 财务
- 第 4 周:(10 月 5 日) • 信息
- 第 5 周:(10 月 12 日) • 逻辑
- 第 6 周:(10 月 19 日) • 数学问题
- 第 7 周:(10 月 26 日) • 数组
- 第 8 周:(11 月 2 日) • 统计
- 第 9 周:(11 月 9 日) • 电子表格
- 第 10 周:(11 月 16 日) • 文字
- 第 11 周:(11 月 23 日) • 插件
- 第 12 周:(11 月 30 日至 12 月 5 日)(最终)
记录完成的项目和从该项目中获得的经验,并记录一些小细节,包括根据需要进行第二次通过校对/编辑,以便准备好提交文档。