На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Факты об открытой еде
- Технический писатель:
- БудущееДокументов
- Название проекта:
- Документирование API Open Food Facts
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
Впервые я услышал о «Сезоне документации» из электронного письма, которое получил от преподавателя курса по документации REST API, который я прошел несколько месяцев назад. Хотя мне очень понравилась эта идея, я решил, что подам заявку на участие в проекте только в том случае, если смогу действительно идентифицировать себя с ним. Это было чем-то, чем я хотел бы заниматься помимо своей основной работы, и если бы я это делал, это должно было бы быть весело и значимо.
Когда я прочитал описание «Фактов об открытой еде», я понял, что нашел этот проект. Я люблю заботиться о своем теле и здоровье посредством физических упражнений и еды. Я действительно считаю, что питание — один из ключей к счастливой жизни, и мы все должны иметь возможность делать лучший выбор, что возможно только в том случае, если у нас есть достаточно информации о продуктах питания и косметике, которые мы используем. Open Food Facts предоставляет эту информацию в наше распоряжение, и я хочу внести свой вклад в эту замечательную инициативу.
Последние три года я работал техническим писателем в компании по разработке программного обеспечения, специализирующейся на автоматизации процессов и выпусков. Среди прочего мы реализовали REST API с помощью Swagger, который позволяет разработчикам взаимодействовать с нашими приложениями через запросы API. Я помог командам разработчиков написать более качественные описания запросов/ответов, и вместе мы определили, какая информация необходима нашим клиентам, чтобы предоставить ее в ясной и краткой форме.
Я просматривал текущий сайт API Open Food Facts и думаю, что мы можем реструктурировать и улучшить документацию, чтобы сделать ее более удобной для пользователя (страницы «Общие», «ЧТЕНИЕ», «ЗАПИСЬ»). Кроме того, мне бы хотелось вместе с командами разработчиков настроить способ автоматического создания документации API из кода (это требует времени, поэтому я предлагаю долгосрочное сотрудничество).
Мы все знаем, что внешний вид важен;) Вот почему мы также можем настроить CSS и логотип REST API, чтобы согласовать пользовательский интерфейс Swagger с пользовательской документацией.
Я с нетерпением жду возможности поработать с вами над этим проектом!