На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Open3D
- Технический писатель:
- Рохан Рати
- Название проекта:
- Техническая документация API Python и C++
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Краткое описание:
Проект будет разделен на 4 части: Обновление и расширение руководства для участников Open3D. Полная документация по API Python. Полная документация по API C++. Высокоуровневая документация по основным структурам данных.
Описание:
В своем проекте я планирую разбить проект на 4 части:
Я планирую дополнить и обновить руководство для новичков, в котором содержится подробное пошаговое руководство о том, как им создавать исходный код, создавать документацию и присоединяться к сообществу разработчиков. В дополнение к письменному руководству я собираюсь сделать видео, демонстрирующее точные шаги по созданию исходного кода для канала YouTube. Я также добавлю руководство о том, как новые разработчики могут внести свой вклад в документацию, внося изменения в исходный код, созданный sphinx, с помощью pybind и doxygen.
Расширьте документацию API Python. В настоящее время API Python содержит базовые строки документации для классов и функций-членов, которые дают расплывчатое описание функциональности. Я планирую перефразировать документацию по API Python, чтобы сделать API более понятным и функциональность более понятной. Я также намерен добавить ссылки на соответствующие концепции 3D-графики, используемые в различных областях (например: внутренняя матрица, используемая в камере).
Заполните документацию по C++ API. В настоящее время в документации C++ нет эквивалентных строк документации по сравнению с документацией Python. Я намерен подробно документировать классы и связанные с ними функции-члены и элементы данных.
Документы высокого и низкого уровня основных структур данных. Я намерен понять код различных структур данных, таких как TriangleMesh, LineSet, Octree, и добавить комментарии в базу кода, как для понимания новых разработчиков, так и для любых пользователей. А также предоставить высокоуровневую документацию по использованию и концепциям, задействованным в структурах, путем улучшения учебных пособий. Я подробно предоставлю примеры использования и добавлю соответствующие ссылки на понятия, задействованные в структурах. Если позволит время, я буду работать над более простыми задачами, такими как документирование того, как выполнять определенные задачи, которые могут помочь новым пользователям подключиться к программному обеспечению.
Расписание проекта-
1 августа - 1 сентября:
Познакомьтесь с моим наставником и обсудите более подробно уровень документации, требуемой в различных частях кодовой базы, а также обсудите, как более подробно изучать документацию низкого и высокого уровня. Я также потрачу это время на понимание кодовой базы и изучение концепций, чтобы лучше их документировать.
Неделя 1 и 2:
Я буду обновлять и расширять руководство для участников. Я улучшу документацию по сборке исходного кода. Я также добавлю раздел документаторов о том, как новые участники могут помочь в документации. Я также сделаю видео на YouTube, шаг за шагом объясняющее, как собрать исходный код.
Неделя 3–5:
Я буду работать над расширением API Python. Перефразируйте существующую документацию и напишите подробную документацию существующих участников. Я также добавлю соответствующие ссылки на связанные концепции, чтобы пользователи могли лучше ознакомиться с рассматриваемыми концепциями.
Неделя 6–8:
Текущая документация по C++ неполна для большей части библиотеки, поэтому большую часть времени я потрачу на заполнение документации по C++.
Недели 9–11:
В течение этого периода я буду работать над основными структурами данных. Реструктурируйте учебные пособия для каждой структуры данных, предоставьте общий обзор, а также задокументируйте подробности использования примеров.
Последняя неделя:
Я использую последнюю неделю для подготовки итогового отчета о работе, проделанной за 12-недельный период документации. Я также потрачу это время на просмотр и доработку документации.