Size: a a a

technicalwriters

2021 April 25

D

Dmitriy in technicalwriters
раз тут все болеют за пользователей... у кого в документации есть указатели (индексы)?
источник

rK

rJIynbIu` KOT in technicalwriters
что это и зачем?
источник

V

Vanderhoöf in technicalwriters
Когда-то в технических книжках в конце был предметный указатель, аналоговая версия Ctrl-F. Может, об этом?
источник

FM

Fox Mulder in technicalwriters
index term
источник

AM

Alexander Muravyov in technicalwriters
Ещё называется Index Keywords, это ещё со времён CHM формата пришло и до сих пор используется. Это в дополнение к дереву содержания (TOC) - хочешь ищешь в дереве, хочешь поиском, а хочешь по списку терминов и сразу попадаешь в нужный топик по какой-нибудь аббревиатуре.
источник

rK

rJIynbIu` KOT in technicalwriters
алфавитный указатель короче, мне такой сфинкс делал сам по умолчанию
источник

ET

Eduard Tibet in technicalwriters
Нету третьего варианта: чтобы компания получила прибыль :)
источник

СФ

Семён Факторович... in technicalwriters
Нужен третий вариант: помочь бизнесу.

Под него, например, подпадает онбординг-документация: ее задача — ускорить введение новых сотрудников в строй, и основной интересант этого процесса все-таки бизнес, а не новые сотрудники.
источник

СФ

Семён Факторович... in technicalwriters
Я к тому, что документация, конечно, почти всегда адресована каким-то реально существующим и нуждающимся в ней читателям, но они зачастую не единственные и не самые главные выгодоприобретатели.
источник

FM

Fox Mulder in technicalwriters
А мне кажется два варианта само собой предусматривает заработок денег компанией. Ведь неважно, нужна ли документация для сдачи проекта или для предоставления некого лица компании перед потребителями, всё равно, бизнес извлекает прибыль.
источник

OR

Olga Revyakina in technicalwriters
Отказались от индекса в пользу поиска. Не смотрят пользователи в индекс, идут в поле для поиска.
источник

D

Dmitriy in technicalwriters
для веба это ожидаемо. docx / pdf не выпускаете?
источник

OR

Olga Revyakina in technicalwriters
В PDF только оглавление у нас популярно )
источник

NV

Nick Volynkin in technicalwriters
Так ведь оба варианта помогают бизнесу. Один в том, что бизнес может закрыть проект, другой в том что бизнес приобретает выгоду, когда документация помогает читателям.
источник

NV

Nick Volynkin in technicalwriters
В целом я с тобой согласен. Этот опрос только проверяет утверждение «Очень часто, практически всегда, документация пишется ради сдачи проекта»
источник

СФ

Семён Факторович... in technicalwriters
тогда я не согласен с твоей формулировкой «помочь пользователям»

кажется, что ты заложил в нее смысл «дать пользователям ответы на их явно задаваемые вопросы»

а в моем примере про онбординг смысл другой: «донести пользователям ту информацию, которую они, возможно, явно не просили (или даже не знают о ее существовании), но которая должна быть им донесена, чтобы бизнесу стало лучше»
источник

СФ

Семён Факторович... in technicalwriters
мой тезис в том, что это две довольно разных цели
источник

FM

Fox Mulder in technicalwriters
Вот шкаф. К шкафу прилагается инструкция по сборке.
Вот кровать. К кровати тоже прилагается инструкция.
Открываю инструкцию по сборке шкафа. Собрал быстро по инструкции. Инструкция понятна. Фирма-производитель шкафа молодцы. Позитивное отношение к ним, рекомендации и дальнейшее сотрудничество.
Начинаю собирать кровать. Один желтый листок мутноватого вида, шрифты расплываются, схемы нет. Вся инструкция по сборке - пару предложений. (сразу напишу, что там была непростая кровать, аля-4 ножки, а достаточно сложная конструкция). Инструкция в помойку, открываем гугл. Кровать была собрана. Куча негатива, антирекомендации и полное нежелание покупать мебель от данной фирмы.
Эти два случая вполне себе реальны, которые произошли со мной.
Первая фирма, не просто сдала проект, а пожелала донести  свои ценности не только через продукцию, но и через документацию.
Вторая - сдала проект. Да и кровать оказалась так себе. То есть не только документация гЪ!
источник

NV

Nick Volynkin in technicalwriters
Я заложил в неё смысл "что-то иное, чем просто сдать проект и никогда больше не читать эту документацию"
источник
2021 April 26

N

Nadya in technicalwriters
Здравствуйте, подскажите, при работе с госзакачиками (не оборонка) всегда ли нужно придерживаться ГОСТ при оформлении документации. Можно ли оставить содержательную часть как в ГОСТ, а вот оформительскую часть на свое усмотрение.
источник