Size: a a a

Технические писатели

2021 December 04

KP

Kseni P. in Технические писатели
Не, уже сами все пробили 😎
источник
2021 December 05

DE

Dmitri Evmenov in Технические писатели
Она не битая, там несколько ссылок, которые без пробелов склеились воедино
источник

DE

Dmitri Evmenov in Технические писатели
Но некоторые по отдельности и правда не работают
источник

DE

Dmitri Evmenov in Технические писатели
А, еще немного наброшу, раз только с работы пришел
источник

DE

Dmitri Evmenov in Технические писатели
Дано: нужно документировать кодбазу проекта, что где лежит и что что делает (ну и как это собирать). Я документирую, но коллеги успевают за день сделать 100500 коммитов, и все это перемещается в совершенно непредсказуемом направлении. и ладно бы в одной ветке, еще и между ветками. Я регулярно делаю пуллы и спрашиваю, а где у вас щас что лежит, они отвечают, но в лучшем случае то, что я написал по актуальной версии в наиболее актуальной ветке, устарело только на полдня. Вопрос: а как с этим правильно справляться? Я в какой-то момент включаю внутреннего пох**ста прокрастинатора и тупо жду, пока они настолько подойдут к выпуску в прод, что надо будет это как-то фиксировать. И то иные вещи мне рассказывают из головы, потому что коллега там что-то не запушил, но вот-вот запушит (в очередную рабочую ветку), пиши с опережением с моих слов. Пишу я быстро, но как-то это мне не кажется хорошей практикой. Перевоспитывать коллег — тоже. Куда бежать?
источник

DE

Dmitri Evmenov in Технические писатели
Это по-своему весело, конечно, и кормит моего прокрастинатора.
источник

DE

Dmitri Evmenov in Технические писатели
Но это как-то плохо пахнет. Есть такая старая шутка, что джаз — это музыка, которую куда прикольнее играть, чем слушать. Вот мои коллеги такие джазмены. А я нет, и как-то нужно коммуницировать и коммуникацию во внешний мир обеспечивать.
источник

DE

Dmitri Evmenov in Технические писатели
я ж не могу по всем веткам и всему этому коммиты собирать. У нас даже таск-трекера нет, все в голове. Мама-анархия.
источник

DE

Dmitri Evmenov in Технические писатели
круто, поздравляю! я вошел некогда как экономист. на позапрошлой работе, когда нужно было писать про СУБД / DBMS, базы данных, с ужасом обнаружил, как у меня из памяти, как древнее зло, поднимается то, что нам про базы дня рассказывали в институте в 1998/99 году, третья нормальная форма и это все. откуда что берется.
источник

АФ

Алекс Фомин... in Технические писатели
источник

M

Maeg in Технические писатели
Вопрос - зачем это документировать постфактум, а не заранее регламентировать, например, именование веток, лейблы коммитов и правила комментирования коммитов? Ну и/или делать хуки коммитов к задачам в тикетнице, а "что где лежит и кто что делает" смотреть уже через тикетницу (стори, таски, сабтаски, это всё)?
источник

F

Fagor in Технические писатели
Не уверен что они по собственнуму так, походу у них поставнока такая, тайм ту маркет, дока потом. Апрув и change должны проходить, а не проходят, слишком "горизонтально".  В общем как вам выплывать - договариваться только как по доке change проводить, накопительно, по дельте и так далее.
источник

ДМ

Данил М. in Технические писатели
Коллеги, кто знает/слышал сколько получают в среднем в месяц на руки технические писатели в США?
источник

V

Vlad in Технические писатели
источник

ДМ

Данил М. in Технические писатели
Спасибо!
источник

О

О in Технические писатели
добрый день, может быть есть у кого нибудь под рукой гайд как описать интерфейс программы? нужно задачу поставить разработчику написать инструкцию по эксплуатации... сроки у нас сжатые (3 дня) поэтому подключаем всех кого можно
источник

VB

Vitaly Belyakov in Технические писатели
ммм, инструкция за 3 дня, моё любимое 😄
общая рекомендация — описывайте не интерфейс, а бизнес-сценарии, которые можно выполнить с его помощью. То есть не "на этой вкладке есть такая-то кнопка, она делает то-то", а "чтобы решить такую-то задачу, выполните в интерфейсе такие-то действия"
источник

DE

Dmitri Evmenov in Технические писатели
В смысле "по дельте"? Не понял.
источник

DE

Dmitri Evmenov in Технические писатели
Потому что у меня как у техписа и не-инженера таких полномочий нет. И там так или иначе главное - это код, а остальное они объясняют в тг или вообще голосом. Документация тут вишенка на торте.
источник

DE

Dmitri Evmenov in Технические писатели
То есть некие артефакты нужны, но только под сдачу.
источник