Size: a a a

technicalwriters

2020 December 25

AS

Anton Samarin in technicalwriters
Hartmann
Кстати, как вариант, пообщаться с ребятами из wtd. Там проф англоязычное сообщество.
Хорошая идея, благодарю вас. Если найду там что-то , то напишу об этом
источник

H

Hartmann in technicalwriters
Anton Samarin
И до Докеров с Жаваскриптами я хочу научиться классно, вкусно писать технические тексты на английском. Как это делает мой коллега Джон.
Здесь ещё субъективная оценка. Может Вы и пишете здорово и при этом кому-то непонятно или вовсе так не нужно. Достаточно, чтобы простыми словами чуть донесли. И порядок.
Зависит ещё от аудитории, для которой пишете и обратной связи.
источник

H

Hartmann in technicalwriters
Две стороны медали: можно быть МухаммедКручеВсехБрюсЛи и при этом получать негативную обратную связь от пользователей.
источник

L

Lex in technicalwriters
Anton Samarin
Опять же, ephemeral port :)
От ephemeral port спасает вычитка доки разработчиком. По этой же причине надо знать хотя бы основы предметной области.

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

JM

Jaroslaw Martinow in technicalwriters
Е Е
А потом открываешь инструкцию к сварочному аппарату, а там одни ямбы с хореями 🤣
1. Распакуй наш аппарат - поработать будешь рад.
2. Ручку в ручку ты бери.
3. Швы ровнее всех вари!!
источник

AS

Anton Samarin in technicalwriters
Hartmann
Здесь ещё субъективная оценка. Может Вы и пишете здорово и при этом кому-то непонятно или вовсе так не нужно. Достаточно, чтобы простыми словами чуть донесли. И порядок.
Зависит ещё от аудитории, для которой пишете и обратной связи.
Согласен, но до определенного момента. Если стараться часто обходиться без проф.терминов, которые понятны аудитории, то тоже не очень хороший путь.
источник

AS

Anton Samarin in technicalwriters
Lex
От ephemeral port спасает вычитка доки разработчиком. По этой же причине надо знать хотя бы основы предметной области.

Вот выше обсуждали, что от техписа требуется быть джун-девелопером. Если техпис пишет для программистов, то да. Уметь написать пример, не облажаться в терминологии - это то, что требует от техписа дополнительных скиллов кроме умения структурировать информацию и писать грамотный текст
Да, но это не всегда помогает. Бывает такое, что контент проходит несколько ревьюеров, а через полгода обнаруживают, что в нём ошибки
источник

H

Hartmann in technicalwriters
Anton Samarin
Согласен, но до определенного момента. Если стараться часто обходиться без проф.терминов, которые понятны аудитории, то тоже не очень хороший путь.
Само собой. Я в общих чертах обрисовал, не имел в виду отсутствия.
Безусловно, без специфических терминов никуда.
источник

H

Hartmann in technicalwriters
Anton Samarin
Да, но это не всегда помогает. Бывает такое, что контент проходит несколько ревьюеров, а через полгода обнаруживают, что в нём ошибки
Какого рода ошибки?
источник

AS

Anton Samarin in technicalwriters
Hartmann
Само собой. Я в общих чертах обрисовал, не имел в виду отсутствия.
Безусловно, без специфических терминов никуда.
Да, конечно. Это ещё один приём, который можно использовать в работе
источник

AS

Anton Samarin in technicalwriters
Hartmann
Какого рода ошибки?
Процедура не выполняется, если в неё передать конкретный параметр, который описан словами
источник

H

Hartmann in technicalwriters
Ну это серьёзно.
источник

H

Hartmann in technicalwriters
Надо не только вычитывать, а ещё и проходить по шагам.
источник

AS

Anton Samarin in technicalwriters
Lex
От ephemeral port спасает вычитка доки разработчиком. По этой же причине надо знать хотя бы основы предметной области.

Вот выше обсуждали, что от техписа требуется быть джун-девелопером. Если техпис пишет для программистов, то да. Уметь написать пример, не облажаться в терминологии - это то, что требует от техписа дополнительных скиллов кроме умения структурировать информацию и писать грамотный текст
Да, и этому тоже нужно где-то учиться. Не с джунской же скамьи убегать в техписатели
источник

AS

Anton Samarin in technicalwriters
Hartmann
Надо не только вычитывать, а ещё и проходить по шагам.
Да, конечно, это и было сделано. Тем не менее, даже это не уберегло от ошибки
источник

H

Hartmann in technicalwriters
Но здесь другой вопрос, сколько на это времени нужно и готов ли бизнес к настолько тщательному тестированию документации.
источник

H

Hartmann in technicalwriters
Время-то оплачивать нужно.
источник

H

Hartmann in technicalwriters
Ну и сроки сдачи увеличатся.
источник

H

Hartmann in technicalwriters
От ошибки никто не застрахован.
источник

AS

Anton Samarin in technicalwriters
Постоянное улучшение документации - это естественный процесс. Но в любом случае хочется расти над собой.
источник