Отличные рекомендации! Спасибо, что поделились опытом. Жаль, что среди технических писателей не так много людей, готовых проявлять инициативу и чего-то добиваться. Мне кажется, что двигателем здесь может быть именно «Я очень рвался работать в серьезных системах по документированию и практиковать на реальных кейсах подход docs-as-a-code», т.е. желание самосовершенствования, роста в проф.знаниях и понимание как и куда хочется расти.
Впрочем, это касается не только техписов, как и вся статья :)
Интересная статья, спасибо.
Жаль, что здравая мысль «налаживайте процесс вычитки документации у себя в команде. Давайте своему техписателю обратную связь. Как положительную, так и конструктивно отрицательную, если вам или пользователям что-то не нравится.» иногда утрируется в компаниях и вызывает противоположный эффект. Т.е. те, кому поручили (может в этом и причина) вычитку, читают документ «наискосок», в перерывах между встречами/совещаниями/обедами и вместо конструктива выдают результат «документация плохая, всё переделать».
Фактически, такая обратная связь даже хуже, чем её отсутствие.
Впрочем, это касается не только техписов, как и вся статья :)
Жаль, что здравая мысль «налаживайте процесс вычитки документации у себя в команде. Давайте своему техписателю обратную связь. Как положительную, так и конструктивно отрицательную, если вам или пользователям что-то не нравится.» иногда утрируется в компаниях и вызывает противоположный эффект. Т.е. те, кому поручили (может в этом и причина) вычитку, читают документ «наискосок», в перерывах между встречами/совещаниями/обедами и вместо конструктива выдают результат «документация плохая, всё переделать».
Фактически, такая обратная связь даже хуже, чем её отсутствие.