Sofya (Все сообщения пользователя)

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на почту! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1 2 3 След.
Оформление РП по ГОСТ
 
[QUOTE]Виктор Фигурнов написал:
[QUOTE] Цахес написал:
мне говорили, что в документации по ГОСТам не используется повелительное наклонение, а используются слова "следует", "требуется", "необходимо". Не могу самостоятельно найти этому подтверждение, но помнится, что где-то это видела.[/QUOTE]
ГОСТ 2.601-95. Эксплуатационные документы
6.4 В тексте документа при изложении указаний о проведении работ  применяют глагол в повелительном наклонении [/QUOTE]
Виктор Фигурнов, столкнулась с тем, что в более новой версии ГОСТ 2.601-2013 есть похожая фраза, но пример приведён странный:

"6.1 В тексте документа при изложении указаний о проведении работ применяют глаголы в повелительном наклонении, например: "Открыть люк...", "Нажать кнопку..." и т.п."

Т.е. сказано, что используется наклонение повелительное, но пример приведён для неопределенной формы глагола. И тогда нормоконтролёр может потребовать писать "требуется открыть люк...", "необходимо нажать кнопку...". Подскажите, как, с учетом вашего опыта, можно интерпретировать эту противоречивую на мой взгляд фразу из ГОСТа?
Изменено: Sofya - 24.09.2018 12:06:55 (опечатка)
Технический проект, Показатели качества в сетях
 
Да, но это же относится к функционалу, а вы про железо спрашиваете... Железо к версионности ПО не относится... к масштабируемости - возможно
Технический проект, Показатели качества в сетях
 
Хм, а в ТЗ прописаны требования к железу и сетям? Если там расписано, что железо для работы системы должно удовлетворять таким-то характеристикам (кол-во ядер, такой-то объем жесткого диска, такое-то подключение к сети), то на это и сослаться со сравнением, что предоставленное железо с такими-то характеристиками, а в ТЗ минимум такие-то... А если такого в ТЗ не написано, то могу разве что предположить, что подойдет расчёт минимальных требований к железу: скажем, системе при эксплуатации нужно хранить 100500 ГБ данных + нужен постоянный доступ пользователя к серверному приложению, тогда и написать, что предоставленное железо имеет такой-то объем жесткого диска и его достаточно для хранения 100500 ГБ данных, а постоянный доступ пользователя обеспечивается с помощью такой-то архитектуры сети + какой-то задел на регламентное обслуживание... Как-то так. Не знаю, как ещё это можно было бы расписать...
Состав ведомостей, Состав ведомостей технического проекта и эксплуатационной документации
 
В ведомость эксплуатационных документов (ВЭД) вносятся документы, которые должны быть переданы конечному пользователю программы для того, чтобы этот пользователь обращался к ним при возникновении вопросов. Соответственно, в ВЭД можно включить руководство администратора.
В ведомость технического проекта вносятся документы, относящиеся к проектированию и созданию системы, т.е. ТЗ, тех проект, эскизный проект и пр. документы.
Сомневаюсь в значимости должности техписа в конкретной компании - как быть?
 
О, как я вас понимаю! У самой такая же ситуация... :-(
Но как по мне так выход один - для собственного роста переходить в пользовательскую документацию, причем активно используемую (Яндекс как пример), т.к. документация по ГОСТ пишется часто как отчётная для галочки и после утверждения её никто не читает.
И даже больше - стать не чисто техписом по работе с текстами, а кем-то, кто делает интерфейсы дружественными: меняет структуру интерфейса, порядок элементов, их вид, упорядочивает типизацию и делает её интуитивно понятной и т.д. - хотя это, наверное, больше к дизайнерству относится.
Потому что обычные пользователи (не на АЭС или в военной отрасли, а те, кто пользуется вордом, приложением в телефоне и т.п.) действительно очень редко читают документацию. Да и зачем им это? К документации обращаются лишь интроверты, которым проще полазить на сайте в поисках подходящего FAQ (т.е. точечно узнавать ответ только на интересующий вопрос), чем звонить в техподдержку, а объёмные фолианты, хоть и хорошо структурированные - и их отпугнут. Соответственно, большие объёмы документации действительно имеют очень низкий приоритет.
А вот создание интуитивно понятного интерфейса - действительно нужная вещь. По части техписательства от этого остается разве что написание контекстной справки...

По вашей ситуации мои мысли следующие:

1) "начальство действительно сейчас решит, что техпис им не нужен и попросит написать заявление" - а у вас часто увольняют в компании? думаю, если им пофиг на документацию, то и на трату денег на ЗП "ненужному" сотруднику тоже пофиг и никто не будет об этом заморачиваться, если у фирмы нет серьёзных финансовых проблем и не предстоят сокращения. Если же предполагаете, что такое действительно может случиться и не хотите этого, то продолжайте делать свою работу - тогда и придраться к вам будет нельзя, уцепиться не за что и увольнять будут других, менее иницитивных.
2) "почему аналитики и оунеры, видя проблемы с руководствами или описаниями задач..." - если честно, не думаю, что они их действительно видят :-) у вас, как у человека, профессионально занимающегося текстами, глаз намётан и такие ошибки вам этот глаз режут, а они их просто пропускают, даже не заметив. Плюс у них есть своя работа и вникать или советовать что-то улучшить коллеге другого профиля - многие или не заморачиваются с этим или считают это нарушением субординации/проф этики. По этой же причине они "мало со мной контактируют, порой не отвечают на сообщения, не проверяют или очень вяло проверяют мою работу" - конкретно на вашу работу им действительно всё равно. Возможный выход: брать на себя ответственность за определённые решения по документации, разобраться, что точно в компетенции аналитиков и оунеров и задавать им максимально конкретные вопросы, ответы на которые отражать в документации, и просить проверять постфактум.

Самое важное, это то, что вы там одна :-( если бы с вами было бы ещё хотя бы два-три техписателя, то и работа была бы живее, вы бы между собой активно спорили, разрабатывали бы стайлгайды, методики, шаблоны, какой-то стиль и подходы. А так вы варитесь в собственном соку. Как и я сейчас :-(

Попробуйте перейти сами в другую компанию, в которой будет побольше техписов и где вы будете заниматься именно пользовательской документацией. Правда, сотрудники, занимающиеся такой документацией, часто не техписами являются, а сотрудниками техподдержки, соответственно ЗП, возможно, меньше и, наверное, не избежать нервотрёпки непосредственного общения с пользователями по телефону.
автоматизация процесса
 
Здраствуйте. Мб не печатать накладную, а отправлять её в электронном виде? Вообще, мне кажется, это больше вопрос электронного документооборота или даже какой-нибудь системы 1С или что-то такое, но не техписательский...
Используемые методы
 
Добрый день!
В ГОСТ 19.402-78 приведено такое описание:[QUOTE]6. В разделе "Описание логической структуры" должны быть указаны:
алгоритм программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учётом текста программы на исходном языке.[/QUOTE]
Исходя из близлежащих элементов к "используемые методы" и из последнего предложения, думаю, что имеются ввиду методы из кода.
Хотя с другой стороны методы из кода более близки к описанию функций составных частей... И тогда, по порядку, после алгоритма программы может следовать как раз метод разработки ПО... Сложный вопрос! :-) Даже не знаю, какой вариант предпочтительнее... Но, думаю, если можно таким образом обосновать и тот и другой вариант, то можно выбрать наиболее удобный - т.е. метод разработки, т.к. перечислить все методы, которые использует современная программа, чрезвычайно тяжело...О_о
Удаление отсутствующего стиля, Удаление отсутствующего стиля
 
Коллеги, подскажите, пожалуйста. Столкнулась с такой ситуацией: открыла в документе "Организатор" на вкладке "Стили", вижу много пустых строк, после которых идут обычные строки с названиями стилей; при попытке удалить такую строку отображается сообщение "Стиль с таким именем не существует" (см. рисунок приаттаченный). Вывела все стили в области стилей - пустых строк там нет. Что это за пустые строки? Как их убрать? Могут ли они в будущем как-то повлиять на работу документа?
Хочу стать техническим писателем
 
Alexija, а чем отличаются требования к техписам для железа от требований к техписам для ПО? Просто интересно, сама не сравнивала никогда, но пока думаю, что разница разве что в используемых инструментах, а вот в типе мышления и в подходе - мне кажется, разницы нет. Ну а инструменты - вещь условная, научиться можно.
Хочу стать техническим писателем
 
Alexija000@gmail.com, хм, а в чём принципиальная сложность перехода с одного ГОСТ на другой? По-моему, дело только в смене работы или отдела внутри компании с переходом туда, где этот ГОСТ используют. Читать что-то дополнительное для этого вообще не нужно, т.к. ГОСТ это такая вещь, что довольно быстро запомнится с практикой.
Не поняла, что под программной документацией подразумеваете? Пользовательскую? Если да, то можно почитать метагайд , у этой же компании Философт можно и курсы различные найти, также можно почитать блог/главред Максима Ильяхова.
В целом по курсам и по обучению можно заглянуть вот сюда https://yandex.ru/blog/x-plain - здесь и анонсы конференций, и насущные вопросы, и отсюда же можно перейти на видео Гипербатона, ПРОТекста и пр конференции - на них тоже очень много полезного и интересного.
Изменено: Sofya - 14.12.2018 18:46:00
Срочная вакансия! Ищем технического писателя.
 
:o Это прямо 4 в 1! По требованиям обычный техпис, а по задачам - так руководитель целого подразделения разработки ПО с доп обязанностями...
техписовские странности
 
Lisa,  :D и такое бывает))
техписовские странности
 
[QUOTE]Lisa написал:
Пост давний, но я знаю сакральный смысл этих манипуляций)
Рисунок и подпись к нему помещаем в таблицу с одной ячейкой. В настройках таблицы запрещаем переносить строки. Скрываем границы таблицы.
Профит! При использовании такого трюка подпись от рисунка не убегает одна на следующую страницу.
Я уже сталкивалась с таким   [/QUOTE]
:o А почему просто не использовать "не отрывать от следующего"? И рисунок с подписью всегда на одной странице находится... Зачем такие извращения?..
Нумерация пунктов в документах.
 
[QUOTE]Laya написал:
Да, в Ворде стили изначально предполагают отступ при маркированном списке на см. вправо[/QUOTE]
Laya, ворд - инструмент западной разработки, в нем заточены стили для западных читателей. Создайте свои красивые и пользуйтесь :-)
Нумерация пунктов в документах.
 
Laya, не пойму, вы говорите, что у вас организация к ГОСТам не привязана, но тут упоминаете нормоконтроль и военные ГОСТы... Так вам надо по ГОСТу сделать или красиво? А нормоконтроль тогда на какой стандарт нормоконтролирует документы? Ваши документы тоже этот нормоконтроль пройти должны? Если нет, то зачем об этом беспокоиться  no-no--smile Я предпочитаю везде отступы, но я русская, пишу на русском, в английском вот и стандарты и привычки ЦА другие, там отступы не любят.
Нумерация пунктов в документах.
 
[QUOTE]Laya написал:
кто как хочет, тот так и оформляет.[/QUOTE]
Самое главное - единообразие. Т.е. если вы один маркированный список оформили одним образом, то и другой список нужно оформить точно также. В ворде для этого существуют стили - советую ими пользоваться.
Очень часто в доках, где качество оформления не важно, к сожалению, подход "кто как хочет, тот так и оформляет" используется повсеместно - даже внутри одного документа все вкривь и вкось, без стилей, без автоформатирования, вобщем ужас. Надеюсь, у вас не так :-)
Нумерация пунктов в документах.
 
Вообще, я такое деление люблю: если важен порядок следования пунктов (например, последовательность действий), то список должен быть нумерованным, а если порядок следования не важен, то делать список (в этом случае он называется перечнем) маркированным. Проблема в том, что в том и другом случае списки могут многоуровневыми. И если для нумерованного списка проблема многоуровневости не проблема, то для маркированного - это может быть проблемой. Потому что приходится выделять уровни более сильными отступами, чем у нумерованного списка. Ну и соответственно, если уровней больше трёх, то выглядит это всё не очень. Собсна, эту проблему я не решила :-) Но может у вас получится)
Нумерация пунктов в документах.
 
[QUOTE]Laya написал:
Моя организация к Гостам не привязана[/QUOTE]
Мне кажется, что раз так, что флаг вам в руки! Очень за вас рада)) А в ГОСТ правила по спискам несколько противоречивы и неполны. Опирайтесь на известные стайлгайды крупных компаний, попробуйте разные варианты и решите, что для вас ближе - примите это за правило и используйте повсеместно. Единообразие и аккуратность всегда красиво)
Хочу стать техническим писателем
 
"Аналитик считает, что мне будет сложно сменить сферу деятельности на ИТ" - тупо как-то, они в резюме что ли не видели, что вы из авиационной области? Зачем тогда своё и чужое время тратить... Как будто резюме не смотрели. Не люблю, когда так делают.
Про компанию слышала, вроде нормальная. Мне тоже стучались, но они в Москву хотят, а я переезжать не хочу.
Не думаю, что в ИТ уйти сложно - вы же не программистом устраиваетесь, а ведь и такие случаи бывают. Часть техписов вообще гуманитарии и ничего, работают. Возможно, первый год придется по сниженному окладу поработать на опыт, а потом уже можно или повыситься или перейти в другую компанию за хороший оклад.
Пробуйте дальше, уверена, что получится! :)
Настройка оглавления, Отступы в заголовках
 
[QUOTE]Mikle написал:
Ну Вы хотя бы сами проверьте, прежде, чем писАть. После форматирования с помощью линейки и последующего обновления оглавления НИЧЕГО не слетает. А вот добавленные пробелы улетучиваются.
В заголовках у меня пробелы, а не табуляция.[/QUOTE]
Вот вы вопрос в начале неверно задали и поправили в таком тоне, будто я неправильно поняла, потом спорите, что нужно ручное форматирование, а не автоматическое, а теперь ещё и грубите. Помогать вам и не хочется после этого.
Настройка оглавления, Отступы в заголовках
 
[QUOTE]Mikle написал:
А то, что Вы описАли - делается обычным форматированием с помощью линейки.[/QUOTE]
Если вы сделаете именно таким образом, а не так, как я расписала, то после обновления оглавления вся ваша настройка слетит.
По поводу пробелов: полагаю, что у вас в самих заголовках стоят не пробелы, а символы табуляции, из-за этого и разница в том, что видите в оглавлении... Можно и в самих заголовках поставить знак пробела, тогда будет одинаково смотреться.
Настройка оглавления, Отступы в заголовках
 
Добрый день!
В word 2017 делается так:
1) Подлиньше способ, если не знаете, где какие стили:
Вкладка "Ссылки", область "Оглавление", в ней кнопка "Оглавление", раскроется список, из которого надо выбрать "Настраиваемое оглавление". В открывшемся окошке нажать кнопку "Изменить", потом выбрать уровень оглавления (т.е. для заголовков 1 уровня выбрать "Оглавление 1", для заголовков 2 уровня выбрать "Оглавление 2" и т.д.) и нажать кнопку "Изменить". Откроется обычное окно изменения стиля, в котором внизу надо раскрыть список по кнопке "Формат", выбрать "Абзац" и настроить там отступы.
2) Покороче, если знаете, где какие стили:
Найти в списке стилей стиль, соответствующий уровню оглавления (т.е. для заголовков 1 уровня выбрать "Оглавление 1", для заголовков 2 уровня выбрать "Оглавление 2" и т.д.), в контекстном меню выбрать "Изменить". Откроется обычное окно изменения стиля, в котором внизу надо раскрыть список по кнопке "Формат", выбрать "Абзац" и настроить там отступы.
нумерация в ворде
 
[QUOTE]Alex_Gur написал:
[URL=https://techwriters.ru/forum/user/19852/]Звёздочка[/URL] , еще раз, добрый день!
Один из ведущих экспертов сайта  [URL=http://wordexpert.ru/forum/viewtopic.php?id=6729]http://wordexpert.ru[/URL] , специалист по нумерованным спискам, подтвердил мне, что стандартного решения поставленной Вами проблемы, скорее всего, не существует. По крайней мере, нам его найти не удалось.
Он правильно написал: " Многоуровневые списки в Ворде - это цирк, но несмешной! "

На работе мы решали вопрос с нумерацией текста внутри разделов следующим образом:  создали стиль простого (одноуровневого) нумерованного списка  и в каждом разделе начинали нумерацию с 1 (правая кнопка мыши -  Начать заново с 1 ).
То есть получалось так:
[QUOTE]3.1. Заголовок
  1. Текст
  2. Текст
  3. Текст

3.2. Заголовок
  1. Текст
  2. Текст
  3. Текст[/QUOTE]
и т.д.

Не очень удобно, но это максимум, чего нам удалось добиться от Ворда.

Еще можно использовать  многоуровневые маркированные списки , что мне нравится больше, так как в этом случае не нужно постоянно изменять нумерацию (не нужно каждый раз начинать нумерацию с 1).


Буду благодарен, если кто-то все же подскажет лучшее решение.[/QUOTE]
По многоуровневым спискам есть хорошая статья - [URL=http://wordexpert.ru/page/sozdanie-stiley-dlya-zagolovkov-i-mnogourovnevyih-spiskov-v-word]http://wordexpert.ru/page/sozdanie-stiley-dlya-zagolovkov-i-mnogourovnevyih-spiskov-v-word[/URL]. Она немного устарела по версии ворда, но разобраться можно - я по ней именно научилась наконец-таки более-менее пользоваться списками и их стилями и связывать их со стилями текста.
нумерация в ворде
 
[QUOTE][URL=mailto:25.10.56@mail.ru]25.10.56@mail.ru[/URL] написал:
Подниму тему.

Всем привет!
У меня возник точно такой же вопрос и я попробовала воспользоваться приведёнными выше советами.
Новый стиль получается таким, как нужно, но при этом слетает нумерация у заголовка 3.
Вожусь с ними уже час, но пока никак не могу найти способ, чтобы заставить эти два стиля одного уровня нумерации мирно сосуществовать.
Помогите понять, в чём тут дело.[/QUOTE]
Звёздочка, у вас стиль "Нумерованный 3 уровня" основан на стиле "Заголовок 3" (можно в окне "Изменение стиля" посмотреть), т.е. он наследует (=принимает) все свойства стил "Заголовок 3" + те отличия от этого стиля, которые вы ему задали, а именно "Шрифт: не полужирный, интервал. Перед:  6 пт, Разрешить отрывать от следующего, Разрешить разрывать абзац, Нет, Стиль: Связанный" - всё, что с этим перечнем не связано меняется в соответствии с изменениями стиля "Заголовок 3". Лучше всего при создании нового стиля или на на каком стиле его не основывать, или основывать на стиле "Обычный", которые практически не меняется от документа к документу. Тогда таких взаимосвязей между стилями и не будет.
нумерация в ворде
 
[QUOTE][URL=mailto:25.10.56@mail.ru]25.10.56@mail.ru[/URL] написал:
Подниму тему.

Всем привет!
У меня возник точно такой же вопрос и я попробовала воспользоваться приведёнными выше советами.
Новый стиль получается таким, как нужно, но при этом слетает нумерация у заголовка 3.
Вожусь с ними уже час, но пока никак не могу найти способ, чтобы заставить эти два стиля одного уровня нумерации мирно сосуществовать.
Помогите понять, в чём тут дело.[/QUOTE]
Возможно, текстовый стиль заголовка связан со стилем списка... или новый стиль связан со стилем списка стиля заголовок 3. Будет лучше, если вы приложите документ, где ошибка и чуть подробнее распишете проблему - в какой момент слетает? какой стиль от какого наследуется? как новый стиль связан со стилем заголовка?..
Страницы: 1 2 3 След.

Рейтинг@Mail.ru