Как упоминалось в предыдущем посте, webpack 2 приближается. Однако есть одно большое препятствие - документация. Текущая документация хороша, если вы уже понимаете webpack. Но если вы только начинаете разбираться в этом инструменте, это нежелательно.

Собственно, это причина, по которой я начал работу над SurviveJS. Одна из его важных составляющих - бесплатная книга по webpack. Часть доходов коммерческой версии напрямую поддерживает проект webpack.

Новая версия → Новая документация

Чтобы сделать webpack более доступным и удобным, мы решили переработать документацию. webpack получит новый сайт с новым дизайном.

Вот здесь-то и пригодятся вы. Нам нужна ваша помощь, чтобы формировать содержание и процесс обучения. Эта работа происходит поэтапно:

  1. Сначала мы создадим темы через трекер проблем нового сайта, который содержит заглушки для необходимого контента. Вопросы будут использоваться для сбора идей, связанных с каждой главой, так что не стесняйтесь присоединяться.
  2. Когда мы согласовали основные идеи для каждой главы, я ожидаю, что люди будут владеть главами, комментируя их на GitHub и записывая их. Скорее всего, я сам напишу немало.
  3. Как только главы становятся владельцами, начинается тяжелая работа, и вы должны фактически написать начальную главу и отправить для нее запрос на перенос. Контент не обязательно должен быть идеальным, поскольку его можно улучшить на этапе редактирования.
  4. Я ожидаю, что после того, как появится контент для проверки, люди (и я) изучим его и отправим дополнительные запросы на вытягивание, чтобы исправить и улучшить его.
  5. Когда документация и сайт будут выглядеть достаточно хорошо, мы опубликуем webpack 2 и насладимся улучшенной версией.

Несмотря на то, что нужно разрабатывать много контента, не все его нужно разрабатывать с нуля. Часть текущей документации можно повторно использовать и переписать в более доступной форме. Трекер проблем webpack и Stack Overflow также могут поддерживать эту работу. Часто одни и те же проблемы повторяются, и вы начинаете замечать закономерности.

Я ожидаю, что для того, чтобы он оставался целенаправленным, мы будем ссылаться на существующие ресурсы, которые будут расширять и поддерживать главы.

Если вы хотите обсудить усилия, присоединяйтесь к нам на the documentation gitter.

Лучший опыт разработчика → Меньше документирования

Я считаю, что простого улучшения документации недостаточно. Мы хотим помочь вам, когда вы тоже напутаете!

Вероятно, самым большим шагом к этому было бы документирование схемы конфигурации веб-пакета на базовом уровне. Webpack-validator уже делает что-то подобное. Также имеется определение TypeScript (с будущей версией 2.x).

«Разработчики, авторы документов, дизайнеры UX, дизайнеры взаимодействия, авторы схем, эксперты по определению TypeScript: мы хотим вас!»

В идеальном мире…

Если бы у нас была хорошо документированная схема, мы могли бы реализовать хороший инструментарий и документацию поверх этого с помощью интроспекции. Исходя из этого, я считаю, что усилия по созданию официальной схемы имели бы большой смысл. Не вся работа с документацией связана с написанием. Иногда речь идет о разработке более сильных инструментов.

Заключение

Даже если вы не считаете себя писателем, я уверен, что вам есть чем поделиться. Как пользователь текущей документации вы, скорее всего, знаете о ее болевых точках. Разработчики, авторы документов, дизайнеры UX, дизайнеры взаимодействия, авторы схем: мы хотим вас!

Прокомментируйте корешки глав в системе отслеживания проблем при работе с документацией или создайте новые проблемы, если чего-то не хватает. Это приведет нас к стабильной версии долгожданного webpack 2.

Вы можете просмотреть все еженедельные обсуждения и планы основной команды, посетив репозиторий заметок о собраниях webpack. Заметки к собранию призваны дать вам ясность и озвучить прогресс и будущее проекта.