Я в чатах уже упоминал, но здесь ещё не было такой информации.

Видимо, начался у меня кризис среднего возраста и я решил поменять работу, профессию и город. Работу уже нашёл и четвёртую неделю работаю разработчиком. В ближайшее время перееду в другой город.

Первые впечатления: вечный кайф. Я много лет занимался всем этим для отдыха и развлечения, а сейчас можно ковырять код в рабочее время и за это платят существенно лучше, чем на предыдущей работе платили за ненавистные бумажки. Причём развиваться на работе начал существенно стремительней, чем раньше, когда это было хобби. Очень здорово.

Единственная проблема в том, что ребята не пишут документацию. Совсем. Как с этим бороться снизу? Есть истории успеха?

+++ Caesium/0.4 RC1

Поздравляю!
В какой город переезжаешь? Что с нодой будет? :)

> Единственная проблема в том, что ребята не пишут документацию. Совсем. Как с этим бороться снизу? Есть истории успеха?

Начини сам писать документацию для своего проекта и добавь сборку оной в ваш CI. Я принес во все наши большие проекты sphinx.
Для некоторых проектов можно собирать документацию из docstring - это для документирования API. А для мелких часто хватает небольшого README.md в корне.

Удачи на новом поприще.

Документация - это всеобщая болезнь, как правило нужен профессиональный писатель. Иногда вместо документации кто-то издает книгу. Комментарии и API - это другое дело.

> Комментарии и API - это другое дело.

Нет, не другое. Смотря какую документацию мы имеем в виду и что пишем. Если у тебя библиотека, которой будут пользоваться многие, то очевидно, что нужно документировать API(вместе с примерами).

Тогда скажу по-другому: есть разные литературные жанры.

> Тогда скажу по-другому: есть разные литературные жанры.

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

Difrex> Главное, чтобы были исходники.

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

Только недавно читал что-то подобное об играх Infocom и даже оставлял ссылку на форуме instead-games.ru.

Кстати, есть еще ЯОП: https://ru.wikipedia.org/wiki/%D0%AF%D0%B7%D1%8B%D0%BA%D0%BE%D0%B2%D0%BE-%D0%BE%D1%80%D0%B8%D0%B5%D0%BD%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%BF%D1%80%D0%BE%D0%B3%D1%80%D0%B0%D0%BC%D0%BC%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5

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

Difrex> Поздравляю!

Спасибо

Difrex> В какой город переезжаешь? Что с нодой будет? :)

Переезжаю в Питер, хотя сроки опять сдвигаются. Нода переедет на арендованный сервер из под дивана :)

>> Единственная проблема в том, что ребята не пишут документацию. Совсем. Как с этим бороться снизу? Есть истории успеха?
Difrex> Начини сам писать документацию для своего проекта и добавь сборку оной в ваш CI. Я принес во все наши большие проекты sphinx.
Difrex> Для некоторых проектов можно собирать документацию из docstring - это для документирования API. А для мелких часто хватает небольшого README.md в корне.

Видимо, единственный вариант. Собственно, его и придерживаюсь :)

+++ Caesium/0.4 RC1

vvs> Удачи на новом поприще.

Спасибо.

vvs> Документация - это всеобщая болезнь, как правило нужен профессиональный писатель. Иногда вместо документации кто-то издает книгу. Комментарии и API - это другое дело.

Ну вот достался мне проект, где был только README с инструкцией по деплою. Правда инструкция была неполная и с ошибками :) Комментариев не было, API документирован не был :)

+++ Caesium/0.4 RC1

>> Тогда скажу по-другому: есть разные литературные жанры.
Difrex> Типа того - документация для пользователей обычно запаздывает, хорошо, когда она вообще есть.

Документация для пользователей меня не особо пока волнует. Тем более, что в конкретно этом продукте всё очевидно для пользователя. One button operation, так сказать.

Difrex> Главное, чтобы были исходники.

Они есть. Только пришлось подтянуть PHP и поверхностно изучить Laravel, чтобы разобраться.

+++ Caesium/0.4 RC1

> Переезжаю в Питер, хотя сроки опять сдвигаются. Нода переедет на арендованный сервер из под дивана :)

Люблю Питер, очень атмосферный город. Следующий в списке на переезд после Минска :). Надо будет пересечься сеткой в Питере :)

>> Переезжаю в Питер, хотя сроки опять сдвигаются. Нода переедет на арендованный сервер из под дивана :)
Difrex> Люблю Питер, очень атмосферный город. Следующий в списке на переезд после Минска :). Надо будет пересечься сеткой в Питере :)

Ае! Первая сисопка! Но я туда пока только поздней осенью перееду, если опять сроки не сдвинутся.

+++ Caesium/0.4 RC1