Написання посібника користувача програмного забезпечення в MS Word

Я збираюся написати посібник (програмне забезпечення для Windows) для програмного забезпечення, яке ми написали для нашого клієнта. Посібник повинен бути максимально детальним. Я буду використовувати MS Word 2010 для написання посібника.

Планую розмістити багато скріншотів різних вікон програмного забезпечення та анотувати на скріншоти. Розмір сторінки повинен бути форматом А4, щоб користувачі могли легко робити роздруківки. Проблема полягає в тому, що якщо я знімаю скріншоти на повний екран (програмне забезпечення займає весь екран, крім панелі завдань), і намагаюся розмістити їх на папері формату А4, багато текстів на вікнах, а також примітки можуть бути важко читабельними.

Щоб полегшити користувачам, я думаю розмістити linksпосібник та embedскріншоти у слові. Натиснувши на посилання, слід відкрити пов'язане вбудоване зображення на весь екран. Користувачі повинні мати можливість повернутися до керівництва із закриттям зображення або без нього.

Проблема в тому, що я не знаю, чи можна це зробити в Word. Це можливо? Якщо ні, чи є альтернативний / кращий підхід?

microsoft-word screenshot hyperlink

— Донотало
джерело

> Я буду використовувати MS Word 2010 для написання посібника - саме тут починаються проблеми. Існують різні інші програми для створення технічної документації, такі як FrameMaker, LaTeX тощо, які краще справляються з навігацією та структурою. Що стосується "спливних зображень", я не впевнений, як цього можна досягти ..

— slhck

@slhck: наш клієнт прийме doc-файли, і якщо ми натиснемо, може бути pdf. до того ж, на жаль, наразі немає досвіду для роботи над згаданим вами програмним забезпеченням.

— Донотало

Відповіді:

Я фактично написав багато технічної документації в Word. Це не той інструмент, який я б вибрав, якби у мене був вільний вибір, але технічні письменники часто цього не роблять.

Те, що ви говорите про це, безумовно, можливо - але можу сказати лише це, коли я роблю деякі припущення щодо того, як ви збираєтеся доставити посібник. Якщо ви плануєте доставляти посібник у форматі PDF та розміщувати ці зовнішні скріншоти в Інтернеті, то так, це можливо. Word 2010 дозволяє вставляти посилання на URL-адреси в будь-якому місці документа. Ці посилання зберігаються, коли ви зберігаєте файл у форматі PDF.

Я думаю, ви робите тут одне погане припущення, і це те, що на скріншоті має бути показано все вікно програми. Я часто захоплюю лише достатньо вікна, щоб користувач міг визначити те саме на власному моніторі.

Ви не питали про програмне забезпечення, але я все-таки рекомендую. У Windows SnagIt - це незамінний інструмент знімання екрана. Це завжди було добре, а з роками стає тільки краще. Механізм захоплення стає все більш потужним і простим у використанні, і тепер чортова річ оснащена досить хорошим графічним редактором, як раз для малювання цих описів.

— Ісаак Рабінович
джерело

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

— Донотало

@Donotalo Тоді як ви плануєте їх доставити?

— Ісаак Рабінович

ми доставимо посібник нашому клієнту. не впевнений, як наш клієнт доставить їх кінцевим споживачам. швидше за все, через локальну мережу або кінцевих користувачів за межами локальної мережі, можливо, є деякі адміністратори, які отримуватимуть документи електронною поштою. адміністратори якось копіюють документи на ПК користувача.

— Донотало

@Donotalo Отже, ви кажете, що не знаєте, в якій формі посібник буде прочитаний, коли його нарешті прочитають? Тоді ви не маєте контролю над остаточним виглядом посібника, і немає жодного способу відповісти на ваше запитання.

— Ісаак Рабінович

Мені шкода, але коли я це сказав? документ має бути у форматі word word (.doc). може бути в .pdf, але я не впевнений. що б там не було, мені потрібно написати це в MS Word.

— Донотало

Альтернативний підхід (який може бути або не може бути здійсненним на основі вашого нового програмного забезпечення) - це трохи пограти із зображеннями.

Чи потрібен їм повний знімок екрана чи ви намагаєтесь звернути увагу на певну деталь?
Якщо ні, можливо, ви можете трохи обрізати зображення.
Чи можете ви зменшити роздільну здатність комп’ютера, щоб зробити знімок екрана з меншим витраченим простором ?
Замість того, щоб робити знімок екрана в 1920x1080, спробуйте зробити його з роздільною здатністю 1024x768 (або дещо вищою / нижчою роздільною здатністю залежно від ваших уподобань. Таким чином, замість того, щоб масштабувати зображення вниз, щоб розмістити сторінку, знадобиться лише незначна зменшити масштаб (або навіть вище), що робить його більш читабельним.

— Роботник
джерело