На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- LibreOffice
- Технический писатель:
- Крежайро
- Название проекта:
- Справочник по функциям Calc и руководство пользователя
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
ЗАПРОС ПРОЕКТА
Я могу легко посвятить 30–35 часов в неделю на этапе технического написания и 10–12 часов на этапе подготовки к написанию, чтобы освоить любые дополнительные навыки, необходимые для проекта. Я хотел бы сообщить вам, что в настоящее время я живу в своем университете (в моей родной стране), где у меня есть доступ к быстрому Интернету и любым дополнительным ресурсам, необходимым для проекта, и я буду продолжать работу в своем университете на протяжении всего срока проекта, поскольку мы находимся в ситуации с COVID-19. Я не думаю, что мой университет начнется в ближайшее время, и даже если это произойдет, я буду на последнем курсе, где я должен посещать занятия только 5-6 часов в неделю, поэтому этого не произойдет. каким-либо образом повлиять на проект.
ВВЕДЕНИЕ
LibreOffice Calc имеет обширный (+500) список функций во многих категориях, документация по которым в справке весьма поверхностна (но тем не менее точна). Встроенный мастер функций Calc также предоставляет пользователю сводную информацию о назначении и параметрах каждой функции. В вики The Document Foundation была создана структура для сбора более подробной справочной информации о функциях Calc.
ЦЕЛЬ
Чтобы заполнить структуру вики, написав более подробное содержимое для каждой из функций Calc, было полезно отметить соответствие стандарту 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: (14 сентября) • База данных
- Неделя 2: (21 сентября) • Дата и время
- Неделя 3: (28 сентября) • Финансовая
- Неделя 4: (5 октября) • Информация
- Неделя 5: (12 октября) • Логическая
- Неделя 6: (19 октября) • Математика
- Неделя 7: (26 октября) • Массив
- Неделя 8: (2 ноября) • Статистика
- Неделя 9: (9 ноября) • Электронная таблица
- Неделя 10: (16 ноября) • Текст
- Неделя 11: (23 ноября) • Надстройка
- Неделя 12: (30 ноября – 5 декабря) (финальная)
Документирование проделанной работы и опыта, полученного в ходе этого проекта, а также работа над второстепенными задачами включали 2-й этап корректуры/редактирования, если это необходимо для подготовки документации к отправке.