🔥

Тред (Алёна Батицкая)


Проект Дока (@doka_guide) — опенсорсный русскоязычный справочник по веб-технологиям. Публично мы запустились 12 октября этого года. Но работа велась последние два с лишним года. Основные принципы: пишем простым, не техническим языком и кроме теории даём практические советы.

На момент запуска в Доке было опубликовано 1011 статей. Сейчас уже больше, благодаря контрибьюторам 🖤
 Конечно же это количество статей не покрывает вообще всё по вебу. Это только начало. Проект развивается и наполняется дальше.

Материалы условно делятся на два типа: 
 - Дока — короткий материал по отдельной сущности (свойству, методу, тегу).
 - Статья — длинный материал, рассказывающий о парадигме, принципе, нескольких сущностях сразу.

Ещё иногда встречаются плейсхолдеры — короткие заметки с основной инфой, которые ждут своего автора для дополнения.

Проект опенсорсный. От комьюнити для комьюнити. Наполняется Дока силами заинтересованных людей, жалеющих делиться знаниями, вносить свой вклад.

Сейчас на Доке 4 раздела: HTML, CSS, JS и Инструменты. В следующем году планируем запустить ещё несколько разделов.

У Доки есть редакция. Сейчас нас 11 человек. Каждый занимается своими задачками. Есть редакторы разделов. На вёрстке я, на JS и инструментах — @N_Lopin. Есть главный редактор @pepelsbey. Есть ещё лит.редактор, ревьюер, фронт- и бэк-разработчики, дизайнеры.

Мы регулярно созваниваемся разными составами для обсуждения всяких текущих вопросов. На прошлой неделе вот планировали следующий год. Для нас он пройдёт под знаком атомного паровоза =)

Ещё в начале проекта решили, что хотим быть добрыми не только внешне, но и внутренне. Хотим чтобы работать вместе было комфортно и не стрессово. Отсюда у нас получилась горизонтальная структура без начальников-подчинённых. Мы благодарные, внимательные и добрые друг к другу.

Сразу был план писать простым языком. По началу даже перегибали палку. Обращались к читателю на ТЫ, использовали просторечия, жестили местами. Хорошо, что со временем (и с появлением лит.редактора) стиль стал лучше. Но всё ещё остался на минималках в плане сложности.

На практике мы сформулировали несколько советов авторам, которые помогут, кажется, при написании любого текста. Мой любимый — начать с фразы «Блин, короче». Остальные можно почитать тут github.com/doka-guide/con…

Если прямо сейчас на сайте вы не можете найти что-нибудь из нужного — приносите статью или хотя бы ишью в репозиторий контента github.com/doka-guide/con… Со временем в Доке будет всё =)

Технически статика собирается на 11ty из двух репозиториев: с платформой и с контентом. Весь контент лежит в Markdown-флайликах, что очень упрощает работу с ним. Многое делается на гитхабовских экшенах. Недавно переехали с Netlify на собственный сервер.

Усиленно работаем в сторону цели максимально снизить порог входа для контрибьютеров. Хотим чтобы процесс правки или написания новой статьи был простым как раз-два.

Логотип Доки и неофициальный маскот — символьная собачка. Мы с любовью называем её Булочкой U•ᴥ•U

Планов у проекта много, все участники редакции любят Доку и заряжены её развивать. Но всё затевалось ради вас. Чтобы быть полезными всем, кто работает с вебом. Приходите контрибьютить!

Алёна БатицкаяАлёна Батицкая