Size: a a a

technicalwriters

2020 November 28

E

Evgenya in technicalwriters
Коллеги, добрый вечер. Мне нужен the Chicago manual of style, может кто-то знает, где можно купить в Москве?)
источник

CV

Cro Vin in technicalwriters
Evgenya
Коллеги, добрый вечер. Мне нужен the Chicago manual of style, может кто-то знает, где можно купить в Москве?)
А какую версию ищете, если не секрет?
источник

НО

Наталья Орлова... in technicalwriters
источник

E

Evgenya in technicalwriters
Cro Vin
А какую версию ищете, если не секрет?
Хотелось бы 17)
источник

CV

Cro Vin in technicalwriters
Evgenya
Хотелось бы 17)
Напишите в личку, чтобы здесь не засорять
источник
2020 November 29

S

Sirius in technicalwriters
Fox Mulder
Термины и сокращения
ТП - технический писатель (техническая писательница)
««««
1. KPI. Данная штука ломает любою возможную инициативу членов разных команд помогать друг другу, если эта помощь никак не повлияет на kpi. Такое встречается как в российских компаниях, так и иностранных, например, я подобное читал про Google
2. Амбиции. Бывает так, что есть, например, две команды разработчиков, которые пилят свои фичи для одного продукта. И тимлиды у них разные, как и проджекты. В итоге, тимлид одной из более успешной команды может игнорить передачу знаний и помощь второй команде.
3. Квалификация техписа. Бывает так, что техпис сильно уступает в знаниях и неспособен беседовать с разрабами на одном языке. В следствии этого, ТП, выпадает из функциональных связей.
4. Перегруженность. Такое случается, когда у компании есть такое кол-во проектов, которые команды не могут переварить. В итоге при 146% разрабов на ТП не остаётся времени.
1. Показатели эффективности каждого человека или всей команды или всей компании?)
Ну это всегда где-то на стыке «быстро» «качественно» (что почти нереально достичь не склонившись больше в одну или другую сторону)
2. Иногда кажется что так и есть, команд разработок несколько..
И никому не хочется чтобы на собрании ТОП тыкал носом - а они быстрее/лучше сделали чем вы (хотя это мне кажется антиклинальным стилем менеджмента)
3. При по приеме на работу никто не требовал знать код и прочие знаний. Все что я изучаю - это по своей инициативе. Но если все знать на уровне разраба зачем оставаться техписом тогда с его зп?)
И ожидают от него просто описать шаги на какую кнопку куда нажать, все доводи интуитивно. По апи только больше поднапрячься поначалу пришлось, там курсы помогли.
4. Не могу оценить есть ли перегрузка у других или нет. 🤷🏼‍♀️ есть способ понять наверняка?
тестировщики слышала жалуются, их всего 6 на 50 разрабов.
Что уже говорить мне, вообще один техпис с расширенным кругом обязанностей. И второго человека как не проси не дают.
источник

IC

Ivan Cheban in technicalwriters
Sirius
1. Показатели эффективности каждого человека или всей команды или всей компании?)
Ну это всегда где-то на стыке «быстро» «качественно» (что почти нереально достичь не склонившись больше в одну или другую сторону)
2. Иногда кажется что так и есть, команд разработок несколько..
И никому не хочется чтобы на собрании ТОП тыкал носом - а они быстрее/лучше сделали чем вы (хотя это мне кажется антиклинальным стилем менеджмента)
3. При по приеме на работу никто не требовал знать код и прочие знаний. Все что я изучаю - это по своей инициативе. Но если все знать на уровне разраба зачем оставаться техписом тогда с его зп?)
И ожидают от него просто описать шаги на какую кнопку куда нажать, все доводи интуитивно. По апи только больше поднапрячься поначалу пришлось, там курсы помогли.
4. Не могу оценить есть ли перегрузка у других или нет. 🤷🏼‍♀️ есть способ понять наверняка?
тестировщики слышала жалуются, их всего 6 на 50 разрабов.
Что уже говорить мне, вообще один техпис с расширенным кругом обязанностей. И второго человека как не проси не дают.
А вы все, что здесь расписали, подробно распишите руководству. Обоснуйте необходимость расширения команды техрайтеров. Скажите, что готовы набрать людей и построить команду — стать лидом.
источник

FM

Fox Mulder in technicalwriters
Вредные советы:

Документация не нужна.
a. Если пришлось документировать, пропусти наиболее “очевидные” места.
b. Не усложняй документацию примерами.
c. Задокументируй отсутствующий функционал, который ты обязательно допишешь потом.
d. Раздели документацию на несколько частей и каждую отдавай только тем пользователям, которые догадаются про неё спросить.
источник

ZL

Zlata Lupilina in technicalwriters
Fox Mulder
Вредные советы:

Документация не нужна.
a. Если пришлось документировать, пропусти наиболее “очевидные” места.
b. Не усложняй документацию примерами.
c. Задокументируй отсутствующий функционал, который ты обязательно допишешь потом.
d. Раздели документацию на несколько частей и каждую отдавай только тем пользователям, которые догадаются про неё спросить.
Как то пункт с. напоминает Напиши ТЗ и сделай пометку done на таске...
источник

F

Fagor in technicalwriters
Fox Mulder
Вредные советы:

Документация не нужна.
a. Если пришлось документировать, пропусти наиболее “очевидные” места.
b. Не усложняй документацию примерами.
c. Задокументируй отсутствующий функционал, который ты обязательно допишешь потом.
d. Раздели документацию на несколько частей и каждую отдавай только тем пользователям, которые догадаются про неё спросить.
так и нужно, и это не вредные. а нормальные. Вы делаете проект на века, марс покорять, или типичный энтерпрайз?
источник

MS

Maria Shabanova in technicalwriters
Пункт с напомнил прошлую работу. Некогда объяснять, проект сдаём через 3 дня, доделать не успеваем, но доки должны быть
источник

ZL

Zlata Lupilina in technicalwriters
Fagor
так и нужно, и это не вредные. а нормальные. Вы делаете проект на века, марс покорять, или типичный энтерпрайз?
Особенно "полезно" будет тем кто на этот проект придет после года-двух его жизни....
источник

F

Fagor in technicalwriters
Zlata Lupilina
Особенно "полезно" будет тем кто на этот проект придет после года-двух его жизни....
все равно проигнорируют доки и свой велосипед начнут изобретать, да и при такой постановке от бизнеса, это даже лучшее решение, с нуля, так как такое легаси, лучше убить
источник

ZL

Zlata Lupilina in technicalwriters
Fagor
все равно проигнорируют доки и свой велосипед начнут изобретать, да и при такой постановке от бизнеса, это даже лучшее решение, с нуля, так как такое легаси, лучше убить
Не всегда. Иногда это развитие проекта и тогда без доки очень тяжко...
источник
2020 November 30

SI

Sigurður Ingvarsson in technicalwriters
Maeg
не знаю про стилистику, но ошибка, скорее всего, в описании. Избыточное понятие "резервная копия". Резервной она была бы, если б было две копии: одна обновлялась, а другая - нет. Ну и ставлю на то, что перед копированием места должно быть в 2 раза больше, чем размер файла.
niet. "резервная копия" – устойчивое выражение
источник

вд

всем добра in technicalwriters
Подскажите пожалуйста, а откуда пошло (как прижилось) правило/рекомендация не использовать в тексте более 6 уровней стилей заголовков?
источник

M

Maeg in technicalwriters
всем добра
Подскажите пожалуйста, а откуда пошло (как прижилось) правило/рекомендация не использовать в тексте более 6 уровней стилей заголовков?
ГОСТ, например. Там обязательна нумерация заголовков, и смотреть на раздел 1.2.3.4.5.6.7 эстетически неприятно.
Да и в автособираемом оглавлении с отступом начинает в глазах рябить
источник

вд

всем добра in technicalwriters
Maeg
ГОСТ, например. Там обязательна нумерация заголовков, и смотреть на раздел 1.2.3.4.5.6.7 эстетически неприятно.
Да и в автособираемом оглавлении с отступом начинает в глазах рябить
Большое вам спасибо за ответ. Я это знаю. Только вот ссылку бы на какой-то документ где это черным по белому обозначено )
источник

AN

Anna Nazolina in technicalwriters
Добрый день!)
Подскажите пожалуйста с чего начать путь в писатели? Где можно стоящие курсы найти?
источник

СФ

Семён Факторович... in technicalwriters
всем добра
Большое вам спасибо за ответ. Я это знаю. Только вот ссылку бы на какой-то документ где это черным по белому обозначено )
так давайте напишем такой документ сами! мы профессиональное коммьюнити или как:)
источник