На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Калейдоскоп
- Технический писатель:
- технический писатель Джилл
- Название проекта:
- Разрабатывать и улучшать документацию Калейдоскопа.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Мне как писателю очень интересен этот проект. В настоящее время я сам использую эргономичную клавиатуру, которая не обладает возможностями Калейдоскопа модели 01, но мое знакомство с разделенной/палаточной раскладкой клавиатуры поможет мне на начальных этапах тестирования и изучения функций прошивки. Мой опыт пользователя аналогичных продуктов также поможет мне определить функции продукта и документацию, которые другие пользователи сочтут полезными.
У меня есть опыт документирования установки и настройки сложных продуктов, и мне очень нравится этот вид работы. Мне также нравится «попрактиковаться» (что в данном случае будет в буквальном смысле) с продуктами и процессами, ознакомиться с ними и написать о них. Я считаю, что это позволяет мне создавать качественную документацию, представляющую реальную ценность для пользователей.
Прежде чем стать техническим писателем, я работал аналитиком службы поддержки, что дало мне бесценные навыки, которые я буду использовать в этом проекте, такие как компиляция кода, тестирование, исследование и воспроизведение проблем.
Я установил первоначальный контакт с Джесси и Гергели из «Калейдоскопа», и мы составили предварительный план, согласно которому, в случае его принятия, я смогу работать над следующими проектами, которые они считают наиболее ценными для своих пользователей:
- Документирование аппаратных плагинов
- Документ, как писать макросы для начинающего пользователя.
- Напишите обзор доступных плагинов
Я работаю полный рабочий день, поэтому могу уделять около 10 часов в неделю в период сезона документации. Это может позволить мне завершить еще несколько небольших проектов в дополнение к вышеперечисленным. Исследуя Калейдоскоп, я заметил, что единственное удобное описание продукта находится на странице Kickstarter. Первоначальный краудфандинговый проект завершился в 2015 году, поэтому я считаю, что необходим веб-сайт, ориентированный на пользователей. Я не веб-разработчик, но буду рад поделиться идеями и текстом для веб-сайта, если Калейдоскоп заинтересован в этом.
Джесси и Гергели предложили прислать успешному писателю клавиатуру, и я думаю, что это будет способствовать успеху проекта.
Я считаю, что мои навыки и опыт делают меня идеальным кандидатом для этого проекта, и я с нетерпением жду вашего ответа.