Как стать автором
Обновить

Комментарии 52

НЛО прилетело и опубликовало эту надпись здесь
Не уверен, что стандартный (ну немножко подпиленный) интерфейс SO идеально подходит для таких вики-доков, но в целом впечатление от нового раздела приятное и многообещающее. Взлетит. :)
НЛО прилетело и опубликовало эту надпись здесь
Лучше бы сделали каталог по качественным ответам, а не писали их ещё раз.
По мне документация это иерархичное описание от простого к сложному, с наличием кросс ссылок, Diff к предыдущей версии. Для меня простым было бы писать в xml или WSWYG, но тот же конфлюенс — убог.
Архитектурно для
Идеально редактируешь у себя на компе, потом commit, и веб сервер уже подхватывает изменения и отображает. Для редактирования нужен редактор, который умеет отображать код как браузер. Все остальное, что пробовал — неудобно.
Так вроде ReadTheDocs подходит по описанию. Для Markdown разметки полно редакторов/плагинов. Требование обязательно XML как-то странно выглядит.
я имел ввиду xml-like
Один пацан писал всё в xml,
и документацию, и DTO,
говорил что нравится, удобно, читабельно.
Потом его в дурку забрали, конечно.
То есть, просто косоглазием не отделался
По описанию сразу напрашивается GitHub Pages + любой удобный HTML/WYSWYG
Да и раньше в гугол бодро посылали. Теперь идти недалеко)
В гугол посылать не много смысла, т.к. он на стековерфловочку и вернет.
Так что да, полезное (пока теоретически) нововведение. Особенно, если дока будет оперативно пополняться теми нюансами, о которых спрашивается.
Ну так вернет вопрошающего на уже существующий ответ) Направить в нужную сторону — уже половина дела.
Я вот люблю специалистов, знающих о предмете понаслышке.

На SO всегда было специальным образом запрещено посылать в гугл и за такие ответы минусуют нещадно. Почитайте правила.
Конечно минусуют, кто же додумается писать в ответ то, что им не является? В комментариях — ничего, вполне поддерживают, неоднократно инициировал закрытие вопросов с такой формулировкой.
Это странно, что удавалось с такой формулировкой инициировать закрытие. SO позиционируется как _база знаний_, посыл в гугл даже за самым тривиальным ответом противоречит логике ресурса. Я лично даже дубликаты закрываю очень осторожно.

Когда спрашивают элементарное из разряда "Что такое наследование в ООП" или что-то вида "вот задание домашней работы, напишите её за меня", то в гугл в комментариях посылают часто, более того минусуют тех кто отвечает на подобные вопросы.

Может быть, я лично никогда не видел минусов за ответы по таким соображениям. Но это очень сильно зависит от рубрики, конечно.

На вопросы типа «Что такое наследование в ООП» всегда есть готовый ответ на самом SO и я обычно не минусую, а закрываю вопрос как дубликат (после тысячи репутации в рубрике дается возможность помечать дубликатами ответы единолично.)

Заходим на ru.stackoverflow.com/documentation/ — 404. Ок, наверное, позже можно ожидать. Заходим по ссылке, выбираем MySQL. Видим странный порядок материалов с заголовками View, INSERT, delete. Разве можно называть стандартом те системы, которые сами по себе не стандартизированы?
Предложил правки, сегодня их приняли. Теперь VIEW, INSERT, DELETE. Уже лучше :)
Удивительно то, что на SO к написанию документации пригласили чуть ли не всех — даже тех, у кого репутации едва хватает на комментарии.
А что, репутация на SO — это хороший показатель?
Достаточный для отсеивания трэша.

Не удивительно, документацию должны заапрувить два человека даже если у тебя > 5 тыс. репутации (по крайне мере, у меня более 5 тыс. и все равно приходится ждать принятия).

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

С нетерпением ждем выхода из Beta и появлении на русской версии stackoverflow!
Русскую версию с нетерпением ждете, чтобы было еще больше проблем с актуальностью, противоречивостью описаний и тому подобной классики?
Нет, русскоязычными ресурсы кажутся более удобными и вызывают больше доверия.
Хочется, конечно, чтобы была максимально полная энциклопедия по всем докам-мануалам. И да, чтобы она была максимально хорошо написана и структурирована. Но увы, будет что-то похожее на вики: информация как-бы есть, но часто на весьма базовом, справочном виде, и если тебе нужно копать дальше, то увы — никто этого еще не написал.

Это как в приколе из баша (текст примерный):
Учусь в универе на *физмате*. И если на 1-2 курсе информацию к экзаменам еще можно было надыбать в интернете, то уже на 4-5 курсах такой специфической информации в открытом доступе попросту нет и нам просто разрешают пользоваться мобильниками.

Нет. Документацию мы вылизывали долго, а эта штука только запустилась.

А смысл тратить силы на сторонний ресурс который еще и в Бете?
Может лучше новый сайт для Yii допилить?

Так никто особо сил и не тратит. Я там ради интереса пару статеек отредактировал за 10 минут и всё. Новый сайт может помочь допилить кто угодно: https://github.com/yiisoft-contrib/yiiframework.com

Очередное окончательное решение вопроса с документацией! Тысячи программистов, у которых всё не доходили руки дописать документацию по своим продуктам, облегченно вздохнули, теперь документацией с энтузиазмом займутся незнакомые индусы.
А тут-то и загвоздка: нельзя так просто взять и добавить на SO доку по своей библиотечке/фреймворку/проекту.

1. Документация привязывается к существующему на SO тегу.
2. Если хочется добавить доку к своему проекту и у него есть тег, то надо открыть заявку (proposal).
3. За заявку (proposal) должны проголосовать не менее 5 человек. Голосовать могут только чуваки с положительно оценёными ответами по данному тегу или имеющие репутацию выше 150.
Зачем на каком-то стороннем форуме писать доку к своему проекту?
OlegMax предлагает открыть заявку по своему проекту, чтоб другие люди писали документацию по нему на SO. А вы потом к себе скопируете.

Это только кажется проблемой. На самом деле все решается за день-два.
Нужно создать вопрос на «Мета» с просьбой создать новую метку.
Объяснить, что Вы хотите создать ее для документирования своего фреймворка.
Очень быстро найдутся участники, которые проголосуют за создание метки.
Такие преценденты уже были. Человек с маленькой репутацией переносил с домашней страницы своей библиотеки мануал по ней в формате QA.
Все решаемо. На СО сидят люди, а не роботы.

Какую метку по какому проекту? Могу создать.
Вряд ли индусы будут там что то писать) Знания языка обычно как и программирования)
Пока что больше похоже на cook book
У стековерфлоу давно существует проблема закостенелых решений. Очень часто встречается, когда гуглишь решения, касательно гита.

Решение, которое было актуальное и хорошее в 2013 — уже не так хорошо в 2016, но набрало уже 100500 апвотов.

С документацией будет тоже самое?

Запрос на изменения любого примера в документации может отправить любой, по сути, я так понимаю, будет вики-подобная модель, когда статьи правят всем миром.

Править тоже не выход, то что вышла новая версия продукта не значит что предыдущей(ими) перестали пользоваться и их надо «исправить».

Исправить не обязательно переписать с нуля. Достаточно вставить дополнения в пост что в такой-то версии продукта команды такие, а с такой-то версии продукта — другие. В вике вполне с этим справляются.

Если будет «вики-подобная модель», то чем википедия плоха?
Я надеюсь SE не будет топить за то, что это именно платформа для документации.

То что я увидел в Яве и в еще паре тем больше похоже на гайды (ну если точнее даже на шпоры). Никакой воды, пример и описание. В случае если тебе нужно уточнить что-то конкретное (и ты знаешь, что ты ищешь), сервис идеален. Для меня, с моей дырявой памятью — уж точно.

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

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации

Истории