На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Джанго
- Технический писатель:
- Габбидрагоценный
- Название проекта:
- Переписать руководство по вкладам, чтобы оно было более удобным для пользователя и с простой навигацией.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
АБСТРАКТНЫЙ
Цель руководства по вкладу Django, как и любой другой документации, — помочь пользователям, в данном случае участникам открытого исходного кода, узнать, как и где они могут внести свой вклад в улучшение и устойчивое развитие Django.
Всегда необходимо создавать документацию, особенно ту, которая сильно влияет на сообщество и сам Django.
Цель Django на Google Summer of Docs в этом году — сделать руководство по вкладам менее запутанным, доступным и гостеприимным для участников. Это очень важная цель, поскольку она поощряет участников, к которым я сам принадлежу, начать вносить свой вклад в эту замечательную структуру.
Текущее состояние
Текущая стадия документации, которую можно найти здесь, на самом деле не является руководством, поскольку она слишком перегружена и плохо структурирована, что приводит к меньшему пониманию вклада в Django и неприятию новых участников.
Цели проекта
Я обсуждал свои предложения по документации с моим наставником Карлтоном Гибсоном на форуме, и он утверждает, что это поможет решить сложную проблему с текущей документацией. Вот цели, которые я планирую достичь по реструктуризации документа: Реструктуризация документа Добавление разделов, что можно и чего нельзя делать. Создание отдельных страниц для тривиальных разделов, таких как запрос и создание функций. Сокращенная и понятная документация. Глоссарий слов. Внутренний указатель, созданный в соответствии с новым руководством. Напишите более понятную и понятную документацию. Сегментируйте содержимое на две основные части (раздел «Начинающие» и «Продвинутые участники»). Создайте руководство и стиль для новых технических писателей/соавторов, чтобы поддерживать документацию в актуальном состоянии и следовать стандартам.
Текущая документация уже ориентирована на опытных участников и не дает возможности новым и начинающим участникам как открытого исходного кода, так и Django. Вот некоторые дополнительные материалы для новичков: Раздел, в котором представлены различные группы участников (технические писатели, дизайнеры и разработчики). ) Страница, на которой документируются проблемы, возникающие впервые, и простые проблемы, которые можно решить. Возьмите несколько разделов из текущей документации, перепишите и добавьте в раздел для начинающих. Разделы, в которых объясняются ключевые моменты или слова, используемые в расширенном разделе.
График
Здесь будет подробно описано, как я хочу работать над достижением цели проекта, указанной выше, с использованием календаря, предоставленного Google.
Неделя связей с сообществом (17 августа — 13 сентября). Больше взаимодействовать с сообществом. Продолжать вносить вклад в документацию. Получать больше предложений от участников. Больше изучать текущую документацию и предполагаемые инструменты. Недели 1 — неделя 4. Начните с разделения документации на основе уровней. Создайте раздел документации для начинающих. Недели 4–6. Курирование правил, что следует и чего нельзя делать. Написание разделов, что следует и чего нельзя делать. Дополнительные страницы для разделов. Недели 7–9. Переписать и перенести текущую документацию в руководство для продвинутых участников. Сокращенная документация. Недели 10–12. Подготовка обновления глоссария. Внутренний указатель. к новой документации. Создать руководство и стиль для новых технических писателей/соавторов.
Инструменты
Sphinx — текущий инструмент для текущей документации. Прочтите Документы.
Почему этот проект?
Я твердо верю в то, что хорошо написанная документация и статьи охватывают всех в любой части мира. Помимо этого, я также любитель Django и открытого исходного кода в целом. Будучи новичком, я собирался внести свой вклад в Django и думаю, что это идеальный способ внести свой вклад в мой любимый инструмент, а также познакомиться с кодовой базой, чтобы внести больший вклад в качестве разработчика (и технического писателя). Будет приятно и приятно работать с организацией, которая соответствует моим взглядам и стала отличным инструментом на протяжении всей моей карьеры.
Почему я подходящий человек для этого проекта?
Я считаю, что я тот человек, основываясь на следующих отзывах: Я вношу свой вклад в Django, пишу статьи, которые помогут новичкам лучше понять концепцию Django. Будучи разработчиком и с нетерпением жду возможности внести свой вклад в Django, я понимаю потребность в коллегах-разработчиках и то, как хорошо для них это документировать. Я командный игрок и буду хорошо работать под меньшим или большим контролем моего наставника Карлтона Гибсона.