Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Оформление инструкции по установке программы в среде Linux
 
Подскажите, пожалуйста, каковы особенности оформления Инструкции по установке программы в среде Linux.
В частности, в каком формате должна быть создана Инструкция по установке для среды Linux, какие указывать системные требования для ОС и для компьютера потребителя, каковы типовые требования к предустановленному программному обеспечению и др.
Спасибо.
Изменено: Alex_Gur - 27.01.2017 16:57:07
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
А чем отличается от Windows?
 
> А чем отличается от Windows?

Вот, в этом и вопрос?
Чем документация для Linux отличается от Windows?
В каком формате должна быть создана Инструкция по установке для среды Linux, какие указывать системные требования для ОС и для компьютера потребителя, каковы типовые требования к предустановленному программному обеспечению и др.
Изменено: Alex_Gur - 31.01.2017 09:42:01
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur написал:
Подскажите, пожалуйста, каковы особенности оформления Инструкции по установке программы  в среде Linux .
В частности,  в каком формате  должна быть создана Инструкция по установке для среды Linux, какие указывать  системные требования  для ОС и для компьютера потребителя, каковы  типовые требования к предустановленному программному обеспечению  и др.
Спасибо.
Уточните (по вашей програме):
1. Тип продукта.
2. Это сервис (daemon) или клиентская программа, ориентированная на ввод/вывод данных.
3. Тип выпуска и релиза продукта
4. Тип распространения продукта (напрямую, электронно, на CD, через партнерскую сеть).

Т.е. нужно больше информации. Там еще много будет вопросов, но хотя бы суть понят.

Предыдущий комментарий оратора "Гость" - из серии "иногда лучше ничего не говорить".
 
Основное и главное отличие - в интерфейсе установки.
В ОС типа Windows - это графический интерфейс (последовательность окон с полями ввода данных и выбором значений),
в ОС типа Linux - интерактивный процесс  (вывод вопроса на консоль - ввод и обработка ответа).
Соответственно, в первом случае инструкция - последовательность окон, во втором - последовательность вопросов.
 
Цитата
Гость написал:
Основное и главное отличие - в интерфейсе установки.
В ОС типа Windows - это графический интерфейс (последовательность окон с полями ввода данных и выбором значений),
в ОС типа Linux - интерактивный процесс  (вывод вопроса на консоль - ввод и обработка ответа).
Соответственно, в первом случае инструкция - последовательность окон, во втором - последовательность вопросов.
Неправильный ответ.
В интерфейсе установки разницы - никакой.

Вам для примера привести Synaptic? Где там консоль?

Обратный пример: установка tzupdater у Java. Где там интерфейс?
Изменено: Текрайтер из Питера - 31.01.2017 16:20:17
 
Цитата
Текрайтер из Питера написал:
В интерфейсе установки разницы - никакой.
Речь идет о стандартных пакетах установка программ в этих семействах ОС.
Конечно, разработчик программы может написать собственную программу установи или заимствовать чужой пакет.
Тогда в графической ОС может появиться командный установщик, а в командной ОС - графический. установщик
В этом случае  вопрос автора топика об оформлении инструкции теряет смысл - он должен просто взять соответствующий установщик и  делать описание на основе его интерфейса.
 
Цитата
Гость написал:
Цитата
 Текрайтер из Питера  написал:
В интерфейсе установки разницы - никакой.
Речь идет о стандартных пакетах установка программ в этих семействах ОС.
Обратите внимание, что ТС об этом ничего не говорил. Т.е. вы сделали вывод о чем-то, не имея на это никаких оснований, не задав ни одного уточняющего вопроса. Т.е. изначально был сферический конь в вакууме.

А ваш отвлеченный пост-вопрос
Цитата
А чем отличается от Windows?
принципиально имеет:
1. Множество ответов (причем множество из них будет правильно).
2. Не несет никакую смысловую нагрузку для ТС. Из вашего ответа невозможно сделать какие-либо выводы применительно к вопросу ТС.
3. ТС не подводится к ответу, а отводится от него.

Т.е иными словами, ваш пост - флуд (м.б. с долей троллизма).
 
Большое спасибо, коллеги!
В целом, понятно.

Последний вопрос: можно ли оформить документацию в PDF.
То есть, будут ли читаться в Линуксе файлы PDF?
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur написал:
Большое спасибо, коллеги!
В целом, понятно.

Последний вопрос: можно ли оформить документацию в PDF.
То есть, будут ли читаться в Линуксе файлы PDF?
Мне кажется, вы не совсем понимаете, о чем говорите.

Есть X11, а есть CLI. Или это web-приложение, которое хостится на CLI, а читается на X11??? У вас какое приложение? Вам как надо читать документацию - ДО установки на другой машине или ВО ВРЕМЯ установки в консоли. Если ВО ВРЕМЯ, то PDF не катит. Нужен просто текст или man. Если же ДО, то пофигу какой формат будет. Ибо ДО читать можно на любой машине - хоть на смартфоне.
 
Цитата
Вам как надо читать документацию - ДО установки на другой машине или ВО  ВРЕМЯ установки в консоли. Если ВО ВРЕМЯ, то PDF не катит. Нужен просто  текст или man. Если же ДО, то пофигу какой формат будет. Ибо ДО читать  можно на любой машине - хоть на смартфоне.

Мне надо, чтобы документацию читали ДО установки на той же машине Linux.
Ответ понятен.
Большое спасибо.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur написал:
Цитата
Вам как надо читать документацию - ДО установки на другой машине или ВО  ВРЕМЯ установки в консоли. Если ВО ВРЕМЯ, то PDF не катит. Нужен просто  текст или man. Если же ДО, то пофигу какой формат будет. Ибо ДО читать  можно на любой машине - хоть на смартфоне.
Мне надо, чтобы документацию читали ДО установки на той же машине Linux.
Ответ понятен.
Большое спасибо.
Думаю, что вам он не совсем понятен.

Если ДО установки на той же машине, то зависит от того, стоит там X11 или нет. Если это чистый сервер (без X11), то у вас только один вариант: README, INSTALL в чистом тексте или man pages (хотя их тоже придется ставить ДО прочтения)
Совет один: скачайте ЛЮБОЙ .tar.gz с src у любого opensource пакета (хоть с github.com, хоть с sourceforge.net) и посмотрите на файлы README, INSTALL - как они устроены, внутренняя структура и  т.п.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить