LINUX.ORG.RU
Форум — Talks  

ГОСТы для руководств?


0

0

Необходимо написать пару мануалов для наших юзеров на работе (достали с глупыми вопросами), возник вопрос: а как их оформлять? Может есть какие то ГОСТы или ISO? Как оформляют техническую документацию например: в каждой фирме свое овормление или по ГОСТам?
ЗЫ пока думаю оформлять как курсовую в академии)

★


как хочешь так и оформляй. если нет на то внутренних распоряжений.

// wbr

klalafuda ★☆☆
()

ГОСТы на документацию есть. Вопрос состоит в том, требуется ли от тебя их соблюдение; и насколько велико твоё желание разбираться в ГОСТах.

Davidov ★★★★
()
Ответ на: комментарий от Attila

> ГОСТЫ бесплатно можно скачать с tehlit.ru

ха! бесплатно... за чтение ЕСКПД я бы ещё и приплачивал и молоко за вредность давал и доп. неделю оплачиваемого отпуска, а то и две.

// wbr

klalafuda ★☆☆
()

Вот жеж мазохисты пошли...

FiXer ★★☆☆☆
()
Ответ на: комментарий от Alex_A_V

Не соглашусь.

Регистр Судоходства люто требует от нас документации по ГОСТу. Хотя какого конкретно ГОСТа следует придерживаться - сами не знают, да.

johan_silver
()

По пакетам в LaTeX

ЕСКД полностью реализовано в пакете eskdx

Документация iso - пакеты iso, iso10303

Но IMHO если не требуется именно ГОСТ, то лучше воспользоваться стандартным классом для отчётов scrreprt или вообще сделать свой класс, как это и было сделано в случае hitec

Evgueni ★★★★★
()
Ответ на: комментарий от johan_silver

>Не соглашусь.

>Регистр Судоходства люто требует от нас документации по ГОСТу. Хотя какого конкретно ГОСТа следует придерживаться - сами не знают, да.

Если требуют, то конечно надо соблюдать, этим я намекнул своим первым предложением. Но судя по тому что у топикстартера возник такой вопрос, то от него соблюдения ГОСТов навряд ли требуют.

Alex_A_V ★★
()
Ответ на: комментарий от Freiheits-Sender

>Это должностные инструкции или правила пользования, но не ГОСТ в любом случае

Это конечно не ГОСТ. Но ОФОРМЛЕН (т.е. внешнее оформелние) должен быть по ГОСТу.

Alex_A_V ★★
()
Ответ на: комментарий от Alex_A_V

> Это конечно не ГОСТ. Но ОФОРМЛЕН (т.е. внешнее оформелние) должен быть по ГОСТу.

Меня в таких случаях бесит слово "должен", кому должен, почему должен?

praseodim ★★★★★
()
Ответ на: комментарий от johan_silver

> Регистр Судоходства люто требует от нас документации по ГОСТу. Хотя какого конкретно ГОСТа следует придерживаться - сами не знают, да.

Тогда фигня вопрос. Придумываете несуществующий номер ГОСТа, придерживаетесь его, на все вопросы отвечаете "секретный ГОСТ".

svu ★★★★★
()
Ответ на: комментарий от Zenom

> ЕСПД же. ЕСКД для чертёжников.

а, дада, точно, спасибо. у нас были в ходу обе -> запамятовал who is who :)

// wbr

klalafuda ★☆☆
()
Ответ на: комментарий от praseodim

>Меня в таких случаях бесит слово "должен", кому должен, почему должен?
В таких случаях отечают "должен потому что должен".

Alex_A_V ★★
()
Ответ на: комментарий от tomodachi_ni_narimashou

Всем спасибо!

>Вику заведи, дуралей

ты себя представляешь среднестатистического клерка женского пола >40 лет? Какая нафиг вики?

lirq ★
() автор топика

Зачем юзверям ГОСТы, для них актуальны комиксы и "делай рас! делай дуа! делай тры!"

Deleted
()
Ответ на: комментарий от AP

> Почитал комменты. Узнаю ЛОР — масса трёпа, и ни одного правильного ответа.

про ЕСПД на которую ты и дал ссылку было сказано ещё вчера.

ps: не могу не процитировать :)

--- cut ---
1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

1.2. Руководство оператора должно содержать следующие разделы:

* назначение программы;
* условия выполнения программы;
* выполнение программы;
* сообщения оператору.

В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.

(Измененная редакция, Изм. № 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ

2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

(Измененная редакция, Изм. № 1).

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

(Измененная редакция, Изм. № 1).

2.4. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

2.5. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. № 1).

2.6. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

(Введен дополнительно, Изм. № 1).
--- cut ---

лаконичность - наше все :)

// wbr

klalafuda ★☆☆
()
Ответ на: комментарий от AP

Можно я тоже узнАю ЛОР? Затерявшийся в конце дискуссии робкий камент по сути заданного вопроса и выявлением бессмысленности остальных каментов.

svu ★★★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.
Talks