Size: a a a

DocOps-сообщество

2019 May 29

EB

Elena Baskakova in DocOps-сообщество
Анастасия Степанова
Это неправильный подход. Зачем тратить силы и время на хоть какую-то документацию, надо сразу писать нормальную документацию. Нет ничего более постоянного, чем временное
👍
источник

AG

Anton Gubarev in DocOps-сообщество
ну то есть в любом случае это тех писатель. Даже для описания функционала продукта, а не внутренней тех составляющей
источник

АС

Анастасия Степанова in DocOps-сообщество
Anton Gubarev
ну то есть в любом случае это тех писатель. Даже для описания функционала продукта, а не внутренней тех составляющей
Да это Технический писатель с опытом Аналитика, либо Аналитик с опытом Технического писателя. Вам не просто Тех. пис. нужен, вам бизнес-логику нормальную править надо. Так как возьмёте Тех.писа он увидит вашу прогу и скажет, что её надо добрабатывать, а потом уже описывать. Грамотный спецалист всё равно укажет на ошибки бизнес-логики
источник

AG

Anton Gubarev in DocOps-сообщество
Анастасия Степанова
Да это Технический писатель с опытом Аналитика, либо Аналитик с опытом Технического писателя. Вам не просто Тех. пис. нужен, вам бизнес-логику нормальную править надо. Так как возьмёте Тех.писа он увидит вашу прогу и скажет, что её надо добрабатывать, а потом уже описывать. Грамотный спецалист всё равно укажет на ошибки бизнес-логики
спасибо за пояснение
источник

NV

Nick Volynkin in DocOps-сообщество
Lana
Искать техписа со специализацией на внутренней документации, описании архитектуры и бизнес логики, он должен уметь и в объяснение логики простым языком, и в код почитать, или растить изнутри
+1
источник

АС

Анастасия Степанова in DocOps-сообщество
Anton Gubarev
спасибо за пояснение
Удачи в поисках! Не знаю как в небольших городах, но в Мск или СПб, такого специалиста найти не так уж и сложно
источник

S

SystemA in DocOps-сообщество
Anton Gubarev
Всем привет. Пришел на один проект а тут документации нет от слова совсем. При этом бизнес-логика местами запутанная и размазана по многим частям. Описывать все самому в условиях текущих проблм уйдет слишком много времени. А проблема действительно насущная, даже менеджеры и продакты уже путаются и не помнят почему оно так работает а не иначе.
Тут очевидно нужен спец по документированию, но раньше с такими ни разу не работал. Подскажите как такие спецы называются? Или может имеет смысл сделать из такого из кого-то из членов команды текущей? Откуда начать копать вообще? Спасибо
Смотря, что вам надо получить в итоге.
Если документацию как работать с продуктом (т.е. пользовательскую), тогда вам нужен технический писатель.
Если необходимо востановить требования заложенные в ПО - тогда системный аналитик.
источник

AG

Anton Gubarev in DocOps-сообщество
SystemA
Смотря, что вам надо получить в итоге.
Если документацию как работать с продуктом (т.е. пользовательскую), тогда вам нужен технический писатель.
Если необходимо востановить требования заложенные в ПО - тогда системный аналитик.
Документацию как работает продукт) Где какие промокоды применяются (или должны применяться) а где не должны. Как происходят различные покупки/апгрейды (много условий заложено в эти процессы) и вот это все.
В дальнейшем надо влезть глубже скорее всего и описать как работа/должна работаь интеграция с каким-нибудь АмоСРМ и тд
источник

S

SystemA in DocOps-сообщество
Anton Gubarev
Документацию как работает продукт) Где какие промокоды применяются (или должны применяться) а где не должны. Как происходят различные покупки/апгрейды (много условий заложено в эти процессы) и вот это все.
В дальнейшем надо влезть глубже скорее всего и описать как работа/должна работаь интеграция с каким-нибудь АмоСРМ и тд
Кто конечный потребитель этого описания, и что он будет с этим делать?
источник

AG

Anton Gubarev in DocOps-сообщество
Менеджеры, разработчики, продажники, все сотрудники компании. Каждый свое, но в целом проблема в том что часто теряется понимание как оно сейчас работает и почему именно так
источник

S

SystemA in DocOps-сообщество
Anton Gubarev
Менеджеры, разработчики, продажники, все сотрудники компании. Каждый свое, но в целом проблема в том что часто теряется понимание как оно сейчас работает и почему именно так
Так не бывает, разработчикам и продажникам, как правило, разная документация нужна
источник

АС

Анастасия Степанова in DocOps-сообщество
SystemA
Так не бывает, разработчикам и продажникам, как правило, разная документация нужна
+1
источник

AG

Anton Gubarev in DocOps-сообщество
SystemA
Так не бывает, разработчикам и продажникам, как правило, разная документация нужна
разработчкам нужна и такая тоже, помимо нее есть еще описание классов программных и прочего, но это другая история
источник

АС

Анастасия Степанова in DocOps-сообщество
Anton Gubarev
разработчкам нужна и такая тоже, помимо нее есть еще описание классов программных и прочего, но это другая история
Просто уже любопытно, а вы сами кем в компании работаете?
источник

AG

Anton Gubarev in DocOps-сообщество
я пришел сюда тимлидом не так давно, и надо как-то налаживать это дело все
источник

AG

Anton Gubarev in DocOps-сообщество
Вопрос документации решался силами разработчиков обычно и проверялся при код ревью. Закодил, напиши простую доку. Но то были другие проекты. Здесь функционал обширный и писать его таким способом займет много месяцев
источник

AG

Anton Gubarev in DocOps-сообщество
поэтому нужен отдельный человек кто этот вопрос поставит и будет вести в дальнейшем
источник

L

Lana in DocOps-сообщество
SystemA
Так не бывает, разработчикам и продажникам, как правило, разная документация нужна
бывает и одна, просто разные уровни абстракции, тут уж как команде удобнее, например у нас описание фичи содержит бизнес-контекст и юзер стори для менеджера, а дальше уже архитектура и описание непосредственной имплементации для разработчика, хранится в репозитории для разработчика и выгружается во внутренний KB ресурс для менеджера, но фактически артефакт один
источник

S

SystemA in DocOps-сообщество
Lana
бывает и одна, просто разные уровни абстракции, тут уж как команде удобнее, например у нас описание фичи содержит бизнес-контекст и юзер стори для менеджера, а дальше уже архитектура и описание непосредственной имплементации для разработчика, хранится в репозитории для разработчика и выгружается во внутренний KB ресурс для менеджера, но фактически артефакт один
Т.е. ТЗ и Руководство пользователя - это просто разные способы абстракции?! 😳
источник

L

Lana in DocOps-сообщество
SystemA
Т.е. ТЗ и Руководство пользователя - это просто разные способы абстракции?! 😳
а я не про тз и руководство пользователя, я про конкретный вид документа, который описывает функциональность (кусок функциональности) продукта и как она реализована. И у нее два вида пользователей - пиэм проекта и разработчики. У нас объединение в один артефакт помогает простроить консистентность и общий контекст от юзер стори и до конкретной архитектуры, как в бд это организовано, какие классы, функции и т.д. Но это реально как в команде договорятся, часто бывает что бизнес и реализацию описывают отдельно, тоже работающая модель
источник