Size: a a a

technicalwriters

2020 July 29

A

Alena in technicalwriters
Не посмотришь, все закрыто)
источник

VI

Vladimir Izmalkov in technicalwriters
Alena
Да это понятно) Тут глобальный совет нужен. Что куда и как. Или тупо ссылку на пдф вставить.
мне кажется, что без серьезных трудовложений только вариант с пдф прокатит. 23 страницы плюс оглавление со ссылками в пдф - это не атк уж и сложно будет осилить.
источник

NV

Nick Volynkin in technicalwriters
Alena
А есть хорошои примеры таких приложений?
Google Analytics, например. Приложение для профессионально использования, посложнее среднего мессенджера. Интерфейс довольно понятный и есть встроенная справка.
источник

NV

Nick Volynkin in technicalwriters
источник

NV

Nick Volynkin in technicalwriters
источник

YD

Yuri Dobrev in technicalwriters
а как будет потом поддерживаться, если пихать в сам апплик? исправили док - выкатывать новую версию прилаги и всем обновлять прилагу?
источник

YD

Yuri Dobrev in technicalwriters
Google Analytics вот у них как? извне откуда-то тянется скорее всего
источник

NV

Nick Volynkin in technicalwriters
Yuri Dobrev
а как будет потом поддерживаться, если пихать в сам апплик? исправили док - выкатывать новую версию прилаги и всем обновлять прилагу?
Приложение может же скачивать ресурсы без обновления.
источник

KT

Kir Tikhomirov in technicalwriters
Nick Volynkin
Я бы предложил сделать кнопку справки на каждом экране и по ним разнести текст. Но лучше — хорошо поработать над текстами в интерфейсе и сделать подсказки на экранах. Так, чтобы в идеале вообще обойтись без отдельной документации.
1. Забиваем в приложение статичные страницы с форматированным текстом.
+ просто и очевидно
- лишний вес приложения
- нужно переработать документацию под формат мп

2. Размещаем документ на вебе, в приложении делаем вебвью.
+ просто и очевидно
+ строго по документации
- неудобно
- нужно развернуть веб

3. Делаем в приложении обучалку/онбординг с описанием функций и действий
+ удобно
+ минимум лишней информации
- самое затратное по часам разработчика
- требует серьёзной адаптации
источник

KT

Kir Tikhomirov in technicalwriters
Yuri Dobrev
а как будет потом поддерживаться, если пихать в сам апплик? исправили док - выкатывать новую версию прилаги и всем обновлять прилагу?
Это можно делать принудительно
Так как у Дарьи приложение внутреннее, для узкого круга, в этом нет проблемы
Проверяем версию, запрещаем использование, если старая
источник

NV

Nick Volynkin in technicalwriters
Kir Tikhomirov
1. Забиваем в приложение статичные страницы с форматированным текстом.
+ просто и очевидно
- лишний вес приложения
- нужно переработать документацию под формат мп

2. Размещаем документ на вебе, в приложении делаем вебвью.
+ просто и очевидно
+ строго по документации
- неудобно
- нужно развернуть веб

3. Делаем в приложении обучалку/онбординг с описанием функций и действий
+ удобно
+ минимум лишней информации
- самое затратное по часам разработчика
- требует серьёзной адаптации
Ой, да какой там лишний вес от текста.
источник

KT

Kir Tikhomirov in technicalwriters
Nick Volynkin
Ой, да какой там лишний вес от текста.
От текста - нет, от экранов с текстом и логикой - да

Иногда идёт сражение и за лишний МБ
источник

NV

Nick Volynkin in technicalwriters
Kir Tikhomirov
1. Забиваем в приложение статичные страницы с форматированным текстом.
+ просто и очевидно
- лишний вес приложения
- нужно переработать документацию под формат мп

2. Размещаем документ на вебе, в приложении делаем вебвью.
+ просто и очевидно
+ строго по документации
- неудобно
- нужно развернуть веб

3. Делаем в приложении обучалку/онбординг с описанием функций и действий
+ удобно
+ минимум лишней информации
- самое затратное по часам разработчика
- требует серьёзной адаптации
2. Ещё нужна авторизация. Но можно сделать веб-компонент в приложении и открывать сайт только им.
источник

YD

Yuri Dobrev in technicalwriters
вот тут чуваки спокойно запихнули портянку текста. даже шрифт не меняли. но есть и инструкция с экранами.
видео такое, потому что в прилаге запрет на захват экрана
не знаю, хороший ли пример))
источник

A

Alena in technicalwriters
Kir Tikhomirov
Это можно делать принудительно
Так как у Дарьи приложение внутреннее, для узкого круга, в этом нет проблемы
Проверяем версию, запрещаем использование, если старая
Алёны) Спасибо большое за советы ❤️❤️
источник

KT

Kir Tikhomirov in technicalwriters
Alena
Алёны) Спасибо большое за советы ❤️❤️
Оу, прошу прощения, меня что-то переклинило
источник

SR

Stas Rychkov in technicalwriters
Дарья Чернавина
Переслано от Alena
Всем привет!
Боль: есть документация (docx) для моб. приложения. Хочу, чтобы она была доступна в моб. приложении.
Посоветуйте как лучше это организовать?
Если сроки не жмут, лучше всё-таки преобразовать в HTML и интегрировать внутрь пакета.

Это не суперсложно.

https://www.techrepublic.com/blog/software-engineer/embedding-html-in-your-android-apps/

https://github.com/lalalic/docx2html
источник

TS

Timur Snytkin in technicalwriters
Подскажите, если мы используем свободное ПО то какую документацию на нее нужно делать?
источник

MS

Maria Shabanova in technicalwriters
Свободную😂
источник

NV

Nick Volynkin in technicalwriters
Timur Snytkin
Подскажите, если мы используем свободное ПО то какую документацию на нее нужно делать?
На кого нее?
источник