Документация По Переполнению Стека Для Всех


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

Согласно переполнению стека, которое он сравнивает с:

“руководство в Интернете, написанное разработчиками”, 

веб-сайт документации:

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

Эта инициатива призвана помочь в борьбе с одной из самых больших проблем, выявленных в ходе ежегодного опроса разработчиков в 2016 году, – плохой документацией, – и Stack Overflow привлекла к участию разработчиков из нескольких технологических компаний, включая Microsoft, Xamarin, PayPal, Meteor и Dropbox. Ожидается, что в будущем другие компании внесут свой вклад, чтобы перенести руководства по своим технологиям на сайт переполнения стека.

Документация на сайте организована вокруг существующего списка из почти 50 000 тегов с веб-сайта вопросов и ответов Stack Overflow. До сих пор только несколько сотен тегов начали работать с документацией. Для каждого тега документация организована по разделам, которые содержат примеры, объясняющие тему, а затем разделы синтаксиса, Параметров и замечаний.

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

Существует система голосования, которая сделает некоторые примеры более популярными, чем другие. Существующий значок вопросов и ответов и репутация распространяются на документацию, накапливая баллы с обоих веб-сайтов. На данный момент трудно сказать, обеспечит ли это такую же мотивацию для участников, как ответы на вопросы и накопление баллов. Мы предполагаем, что этого не произойдет. Причина в том, что ответить на вопрос проще, потому что ответ направлен и определяется вопросом – документация открыта и гораздо сложнее. 


Добавить комментарий