Привет! Подскажите такой вопрос. У нас в компании взяли ещё

Question

Привет! Подскажите такой вопрос. У нас в компании взяли ещё

одного техписа, я здесь работаю на данный момент 1 год, новый техпис сейчас работает на другом проекте. По работе пришлось ознакомиться с документацией, которая написана им. Очень много ошибок в плане форматирования, разный шрифт, пробелы, абзацы то есть, то нет и т.д. Плюс ошибки по структуре документов. Как считаете, надо ли обратить внимание руководителя на это? Возможно предложить свою помощь (или попросить рост моей должности до главного техписа 🤭)?

0

08.08.2023

42 ответов

30 просмотров

Bogdan Larson

Как считаете, надо ли обратить внимание руководителя на это? -- зачем, что это тебе даст? И что тебе даст рост должности до главного тп (в команде из двух тп)?

0

08.08.2023

Аня Раневская

Думаю, сначала подойти к коллеге и предложить ему некоторые улучшения, которые помогут облегчить работу и улучшить результат. А потом уже обратить внимание руководителя)

0

08.08.2023

Oriella Natali Автор вопроса

Bogdan Larson
Как считаете, надо ли обратить внимание руководите...

Мне не нравятся некрасивые документы) а рост должности подразумевает рост ЗП

0

08.08.2023

Елизавета

Привет! Я бы помогла новичку разобраться с тем, как сделать лучше. Подсказала, что почитать для развития в должности. Может быть, разработала бы вместе парочку шаблонов. Иными словами, сначала обратила бы внимание самого коллеги на его погрешности. Возможно, он новичок в этой области и ему нужна помощь. Как более старший товарищ, я бы эту помощь предоставила.

0

08.08.2023

Angelina Lisovskaya

Аня Раневская
Думаю, сначала подойти к коллеге и предложить ему ...

Есть золотое правило. Не спрашивают - не лезь. Данная ситуация может ввести в конфликт. Тем более, мы не видели документы обоих тех писов.

0

08.08.2023

Lidia Tulyaganova

Oriella Natali
Мне не нравятся некрасивые документы) а рост должн...

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

0

08.08.2023

Oriella Natali Автор вопроса

Только в теории)

0

08.08.2023

Bogdan Larson

Oriella Natali
Только в теории)

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

0

08.08.2023

Елизавета

Angelina Lisovskaya
Есть золотое правило. Не спрашивают - не лезь. Дан...

Вот, кстати, важное замечание. Правильно объяснить, что все с чего-то начинали, зачем это нужно и т.д. Хороший пример:" Вася, я читал твою документацию. Написано хорошо, но хотелось бы видеть всю нашу документацию в одном стиле. Это было бы удобнее для всех и сэкономило бы много времени читателю. Давай обсудим как можно привести статьи к единому формату. Возможно стоит разработать шаблоны и обсудить оформление?" Плохой пример:" Вася, я читал твою документацию. Почитай книги для новичков, глаза режет оформление." Сугубо личное мнение.

0

08.08.2023

Аня Раневская

Angelina Lisovskaya
Есть золотое правило. Не спрашивают - не лезь. Дан...

Мне кажется, что такое правило может привести к довольно пассивной позиции. Я лезу всегда и везде - главное уметь сделать это грамотно и принять "нет", если тебе отказали. Кратко: попробовать влезть можно, если отшили - отстань и не грусти)

0

08.08.2023

Largus

Этот проект пересекается с вашим?

0

08.08.2023

Oriella Natali Автор вопроса

Largus
Этот проект пересекается с вашим?

На данный момент нет, но учитывая, что я в компании занимаюсь практически всеми проектами, то в дальнейшем может пересечься.

0

08.08.2023

Bogdan Larson

Аня Раневская
Мне кажется, что такое правило может привести к до...

Грамотно это как? На примере ТС, скажем.

0

08.08.2023

Аня Раневская

Елизавета
Вот, кстати, важное замечание. Правильно объяснить...

Грамотно - примерно так. С посылом "у меня есть идея, как помочь и сделать круче. подходит ли она тебе? что ты думаешь?", а не "у тебя плохо, давай научу как надо"

0

08.08.2023

Елизавета

Аня Раневская
Грамотно - примерно так. С посылом "у меня есть ид...

Да, нельзя забывать, что вы команда, в первую очередь.

0

08.08.2023

алЁна

Возможно на прошлой работе для него это было нормой. Вы с ним это обсуждали? Да и возможно на нынешней тоже прокатит, подпишут. Если единообразие является сугубо Вашим желанием, то донесите это до коллеги, других вариантов нет. Какой смысл разводить конфликт, сразу бежать к руководству и тд и тп…

0

08.08.2023

Алексей Таразанов

Добрый день! А как Вы общаетесь с вашим коллегой? У вас хорошие рабочие взаимоотношения? Как он принимает помощь, комментарии и обратную связь?

0

08.08.2023

Oriella Natali Автор вопроса

Алексей Таразанов
Добрый день! А как Вы общаетесь с вашим коллегой?...

Мы все на удаленке. Общалась только один раз, когда нас представил руководитель друг другу 🤷🏼‍♀️

0

08.08.2023

Stas Rychkov

Привет. Кажется, хороший способ понять, почему руководство по стилю не работает. Или создать такое совместно на основе этого документа. Если ошибки разного типа, можно создать список проверки документа перед передачей редактору.

0

08.08.2023

Oriella Natali Автор вопроса

Stas Rychkov
Привет. Кажется, хороший способ понять, почему рук...

У нас нет редактора

0

08.08.2023

Stas Rychkov

Oriella Natali
У нас нет редактора

Тем более. Ошибки — это нормально. Важно понять, что они исправляются. Возможно, у вас разный стиль подачи, у вас самое лучше чувство языка, поэтому какие-то ошибки коллеги слишком сильно обращают внимание. Попытайтесь сперва понять, что за ошибки, и собрать их в общий документ по стилю, если такого ещё нет. Есть вам отказываются помогать, что ж, создайте сами, а потом на встрече с командой объясните, почему это важно. Такое руководство совсем не обязательно должно быть монументальным трудом. Часто достаточно просто списка проверки. Которой как раз и можно создать на плохом документе.

0

08.08.2023

Alex Alex

Oriella Natali
Мне не нравятся некрасивые документы) а рост должн...

Рост в должности не всегда (и зачастую не) подразумевает автоматического роста в ЗП. И к вопросу о "красоте" документов (я, правда, не в курсе ситуации на Вашем проекте) - поверьте, наличие "некрасивой" документации сильно лучше отсутствия "красивых" документов

0

08.08.2023

Tess Tess

Oriella Natali
Мы все на удаленке. Общалась только один раз, когд...

Справедливо отмечено, что информации о ситуации мало, но тем не менее. Затевать единообразие-аккуратность-борьбу за качество в масштабе больше, чем вы как рабочая единица, нужно всегда, заручившись поддержкой руководства. Сначала вы находите единомышленника, которому тоже это надо и он при этом может что-то решать, а потом организуете улучшайзинг. Извините, по мне, советы "подойди и предложи помощь" в такой аморфной ситуации, какой она представляется, - бред какой-то. Нет там "одной команды". Для больших перемен у вас должен быть план, холодная голова и терпение. Я бы сначала подождала, пока чужой проект прилетит ко мне, я потрачу время на переделку, посчитаю перерасход трудозатрат, и предложу руководству решение, чтобы такого впредь не было. Это если хотите в этой органищации быть надолго и карьерно расти. А так-то может из этого колхоза просто надо уходить, не дожидаясь, когда в нем зародится разумная жизнь

0

08.08.2023

Alex Alex

Oriella Natali
Мне не нравятся некрасивые документы) а рост должн...

Вообще ценность технической документации определяется не ее видом и оформлением, а полнотой и актуальностью. Так что может лучше потратить усилия не на оформление, а на улучшение содержания

0

08.08.2023

Ярославна

Ой, а можно к вам а компанию? Я отлично форматирую тексты!)))

0

08.08.2023

Ольга Лебедева

Alex Alex
Рост в должности не всегда (и зачастую не) подразу...

Особенно если на всю контору только два техписа, при росте и отсутствии претензий от клиентов, может быть уже цель в количестве и наличии)

0

08.08.2023

Maeg

Alex Alex
Вообще ценность технической документации определяе...

есть такая армейская поговорка: "безобразно, но однообразно". Если _техническая_ документация оформлена в едином стиле, то пользователи, привыкшие к особенностям изложения, тратят меньше времени на прочтение текста и научаются выхватывать из простыни те куски, которые им нужны. Пример - оформление кусков кода отбивками и шрифтом. И время, затраченное на разработку и утверждение стандарта, окупается очень быстро: ведь не только пользователь меньше анализирует текст, но и техпис меньше задумывается "какой стиль мне применить в этот раз", а тупо тыкает в нужный стиль шаблона, например.

0

08.08.2023

Nick Volynkin

Я не понял, а почему рост должности? Если человек ошибается — поговорите об этом с самим человеком сначала

0

08.08.2023

Stas Rychkov

Alex Alex
Вообще ценность технической документации определяе...

Это всё про единство формы и содержания. Тут ведь снова про договорённости. Если вы в команде решили, что форма для вас не важна, например не вы её определяете, наверное так и есть. Иначе — «форма существенна. Сущность формирована так или иначе в зависимости и от сущности». Ленин.

0

08.08.2023

Alex Alex

Коллега, это все правильно и сомнений не вызывает. Но есть два аспекта. Первый- это когда все идет в печатном виде, то все эти форматирования/оформления имеют смысл. А давайте зададим вопрос - а что для пользователя техническая документация? Красиво оформленный фолиант в шкафу? Или переведенное из .pdf в .fb2 Руководство по инсталляции и загруженное на мобильный телефон, чтоб на нем не красоту стилей смотреть, а найти быстро параметры скрипта инсталляции. Посмотрите на то, как в реальной жизни документация используется, а не как сдается в виде 10 коробок печатной бумаги

0

08.08.2023

Oriella Natali Автор вопроса

Alex Alex
Коллега, это все правильно и сомнений не вызывает....

У нас очень много госзаказов у компании, поэтому и много отчётов и документов оформляется в печатном виде. Проект, в котором работает коллега, только отправится на регистрацию в реестр РПО. Там нет требований к оформлению по ГОСТ, но в дальнейшем скорее всего понадобится.

0

08.08.2023

Дарья Курнаева (Чернавина)

Alex Alex
Коллега, это все правильно и сомнений не вызывает....

Качественно оформленную информацию удобно читать -> пользователь быстро найдёт нужную информацию -> это сэкономит ему время.

0

08.08.2023

Maeg

Alex Alex
Коллега, это все правильно и сомнений не вызывает....

в реальной жизни она у меня на сайте, с поиском :) И верстать её с заданными стилями сильно проще... хотя в веб и выбора-то особого нет :)

0

08.08.2023

Natalya Antonova

Из опыта на прошлом проекте, нас было трое и документацию делали неодинаково. Хотя были мои шаблоны, потому что начинала я документацию на проекте. Руководство не требовало единообразия и фонд, куда всё сдавали это устроило. Если у вас такая история, нет смысла идти к руководству. Когда проекты пересекутся у вас будет возможность что-то поправить в общих документах. Я так делала без выяснения отношений с коллегами.

0

08.08.2023

Ольга Лебедева

Oriella Natali
У нас очень много госзаказов у компании, поэтому и...

У вас были вопросы/уточнения и прочие признаки от заказчика что он вообще это все читает?

0

08.08.2023

maria

Angelina Lisovskaya
Есть золотое правило. Не спрашивают - не лезь. Дан...

Во-первых, есть ли у вас вышестоящий руководитель, который бы контролировал качество документации/поставленных задач? Или человек, выполняющий такую роль. Наверняка, девушка должна на испытательном сроке себя показать, к ее работе должны присматриваться и кто-то должен оценивать качество выполненных ею задач. Во-вторых, я сама как бывший руководитель техписов, была бы огорчена, если бы такие вопросы решались без моего участия :) Идеально было бы без оценочных суждений предложить помочь коллеге-джуну через своего руководителя. Сделать вместе шаблоны. Сделать совместную вычитку ее документов. Показать на живых примерах фрагментарно как нужно и как, допустим, у нее.

0

09.08.2023

Angelina Lisovskaya

maria
Во-первых, есть ли у вас вышестоящий руководитель,...

Этот вопрос лучше адресовать девушке, которая задавала вопрос. Вы написали всё то, о чем я писала вчера ). Наше мнение совпадает) 🌸

0

09.08.2023

maria

Angelina Lisovskaya
Этот вопрос лучше адресовать девушке, которая зада...

Простите, я промахнулась, видимо, старалась поскорее ответить за минуту до совещания :)) Спасибо за поддержку!

0

09.08.2023