?

Log in

No account? Create an account
Cообщество технических писателей's Journal
 
[Most Recent Entries] [Calendar View] [Friends]

Below are the 20 most recent journal entries recorded in Cообщество технических писателей's LiveJournal:

[ << Previous 20 ]
Sunday, April 23rd, 2017
1:27 am
[aka_author]
Правильное и неправильное в языке
Готовимся к бесплатному семинару "Правильное и неправильное в языке". Я к нему готовлюсь, во всяком случае, и вас, дорогие коллеги, к тому же призываю.

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

Grammar Nazi на связи

Кстати, как вы относитесь к тому, что в переписке после обращения все реже ставят восклицательный знак, и все чаще запятую? То есть, вместо Дорогая бабушка! или Уважаемый Сергей Сергеевич! пишут Дорогая бабушка, или Уважаемый Сергей Сергеевич,. Это годится, или мы этим коверкаем русский язык, бездумно перенимая заграничные манеры?
Saturday, April 15th, 2017
12:35 am
[aka_author]
Правильное и неправильное в языке
Здравствуйте, дорогие коллеги! Есть кое-какие новости.

Во-первых, может быть, вам будет интересно посмотреть видео с небольшой конференции на тему понятности языка.



Во-вторых, в июне мы наверно устроим бесплатный семинар примерно на следующую на тему: "Правильное неправильное в языке. Откуда мы знаем, что правильно, а что нет".

Несколько слов о наших недавних и дальнейших семинарах.
Friday, March 31st, 2017
11:19 pm
[aka_author]
III форум ИТ-решений
(Кросспост из блога Философта.)

5 апреля 2017 года «Философт» участвует в III форуме ИТ-решений, который проводит Сообщество ИТ-директоров Global CIO. Форуму будет сопутствовать небольшая выставка, на этой выставке у нас будет стенд.

На форуме мы будем представлять наши услуги и решения для документирования ИТ-инфраструктур. Основные темы таковы:

- разработка документов, предусмотренных ITIL (планы непрерывности и т. п.);

- описание бизнес-процессов с помощью интерактивных сценариев;

- система управления контентом DITAToo;

- программа пакетного формирования документов CopyPaste Monster.

Также на нашем стенде можно будет обзавестись кое-какой литературой, вот ее список:

- Кагарлицкий Ю. В. Разработка документации пользователя программного продукта. Методика и стиль изложения;

- отчет «Рекомендации библиотеки ITIL по техническому документированию. Результаты исследования источников»;

- отчет «Стандартизация оборонной продукции. Нормативные акты и ГОСТ, относящиеся к оборонной продукции (работам, услугам) ».

Для представителей ИТ-подразделений регистрация на III форуме ИТ-решений бесплатная.

Наш стенд № 5.
Tuesday, March 28th, 2017
5:54 am
[aka_author]
Инженерский язык
(Это статья из блога Философта.)

Давно, еще в 90-е годы, был у нас один заказчик, выпускал он сложную программу с большим количеством графики и математики. Мы написали к этой программе руководство пользователя, довольно объемное, несколько сотен страниц. Написали, отдали.

Тут надо сказать, что за документацию у этого заказчика отвечал А. В., пожилой инженер, что называется, советской закалки, флегматичный, даже немного мрачноватый, и не склонный к острым эмоциональным реакциям. По крайней мере, так нам казалось. Вдруг получаем от него письмо: «Ваша документация никуда не годится. Срочно приезжайте, будем разговаривать». Нам стало не по себе: как же так, несколько месяцев работы в корзину? Собрались с силами, поехали, ожидая выговора, и гадая о возможных его причинах.

«Так документацию не пишут!», — с порога заявил нам взволнованный А. В., — «Все надо срочно переделать».  Набравшись самообладания, мы вступили с нашим зоилом в переговоры.

— А. В., объясните, пожалуйста, куда именно наша документация не годится? Что будем переделывать?

— В ней какие-то устаревшие слова.

— Какие устаревшие слова?!

— Ну, вот, вы пишете: «Снова нажмите на кнопку OK», а так писать в документации нельзя. Не «снова», а «повторно».

Мы все переделали за полчаса с помощью нескольких поисков и замен.

Другой заказчик занимался промышленной автоматизацией. Мы разрабатывали для него эксплуатационную документацию. Старались писать как можно яснее и проще, чтобы операторам на предприятиях не приходилось задумываться над каждым абзацем.  Заказчик нашей работой был доволен, но не совсем. «Вы все правильно написали», — резюмировал он, — «но как-то не по-инженерски». Тогда мы уже примерно понимали, что имеется в виду, и внесли в документы необходимую правку.

Что же это за «инженерский язык»? Не берусь дать ему четкое определение, но мне ясно, что его невозможно свести к употреблению терминологии в собственном смысле слова. Это стиль или способ изложения материала, диктующий определенный выбор слов общеязыковой лексики и синтаксических конструкций. Приведу несколько примеров соответствия между обычными словами и словами, характерными для «инженерского» языка.

Нейтральное слово «Инженерское» слово
большой значительный
вовремя своевременно
вынимать извлекать
класть помещать
мешать (чему-л.) препятствовать (чему-л.)
можно допустимо, допускается
начинать (делать что-л.) приступать (к чему-л.)
работать (о технике) функционировать
снова повторно
убирать (что-л. откуда-л.) удалять (что-л. откуда-л.)
человек (о субъекте действия) лицо

А какие слова или другие признаки «инженерского» языка знаете вы?

Научиться этому стилю несложно. Читайте больше текстов, написанных инженерами, и у вас все получится. Интересный вопрос — для чего этот стиль нужен. Конечно, можно было бы объяснить его существование одной только склонностью специалистов старой формации к формализму и бюрократии. Но я убежден, что любое явление, устойчиво присутствующее в языке, по-своему функционально, необходимо говорящему и слушающему, пишущему и читающему. Только мы не всегда понимаем, зачем. Возможно, у коллег (особенно, с филологическим образованием и даже степенями) есть версии насчет «инженерского языка».
Thursday, October 20th, 2016
4:08 pm
[kharitonov]
Вакансии
Дорогие коллеги!
У нас вакантны две должности:
1) технический писатель;
2) технический писатель со знанием английского языка.
Резюме принимаются по адресу job@aladdin-rd.ru.
Friday, December 4th, 2015
10:45 pm
[exo_morph]
WORD и VBA
Всем привет!

Давно уже чешется мне научиться грамотно писать макросы для Word. Не такие, которые через графические кнопочки "начать запись", "закончить запись", а кодом. В общем, я, конечно, понимаю, что есть литература по этому вопросу, но всё же - может кто знает, есть ли в Москве какие-нибудь хорошие, дельные курсы по этому делу? Для начального форсажа, так сказать. А то, если не знаешь, с чего начать, то сложно учиться только по литературе.
Monday, November 30th, 2015
7:12 pm
[valeriatutu]
Ищем техписателя в Туту.ру, Москва
Всем день добрый!
Очень ищем техписа в компанию Туту.ру (http://www.tutu.ru/) на пользовательскую документацию в раздел по продаже железнодорожных билетов, подробнее здесь: http://balashikha.hh.ru/vacancy/15149729
Если заинтересуетесь, то пишите на prudnik@tutu.ru (Валерия), звоните по номеру +7 (495) 787-52-05
Thursday, August 6th, 2015
5:58 pm
[natmsrspb]
Форум Философта
Всем добрый день!
Жаль бесконечно, что философтский форум прекратил свое существование (((.
Подскажите, пожалуйста, куда переместились профессионалы из этого форума?

А то возник вопрос по word 2010, надеялась, что здешние гуру помогут, но увы ((((.
С уважением,
Наталья (СПб)
Monday, March 23rd, 2015
2:35 pm
[aka_author]
Как писать документацию по-английски?
Здравствуйте, дорогие коллеги!

Тем, кто пишет документацию по-английски или хочет этому научиться, возможно, имеет смысл обратить внимание на методичку, которую выпустила ассоциация tekom.

Guideline. Rule-Based Writing—English for Non-Native Writers. — Stuttgart: tekom, 2014. — 115 с.

ISBN 978-3-944740-05-8

Где взял: http://www.technical-communication.org/publications/downloads.html

Обзор по-русски: http://www.philosoft.ru/engwr.zhtml
Wednesday, October 1st, 2014
12:45 pm
[lynxish]
ищу техписателя, Москва
Коллеги, ищу технического писателя. Обязательно с опытом, обязательно с аналитическим складом ума и способностью объять необъятное :) Зарплата рыночная, коллеги отличные, атмосфера позитивная! За подробностями можно в личку или вот сюда: http://hh.ru/vacancy/11771824
Monday, April 28th, 2014
10:29 pm
[regana]
2:22 pm
[drbotkin]
Tags in Google Docs

Доброго времени суток, коллеги

Возник вопрос по ислоьзованию Google Docs. Сценарий таков:

1) Есть единый документ в Google Docs. Документ достаточно большой. В этом документе много разделов уровня Heading 1, Heading 2, Heading 3.
2) Некоторые часть документа предназначены "для всех", другие будут особенно интересны разработчикам, третьи для QA.

Задача:
Google Docs, вроде, предпологает добавление тегов. Но я не нашел как это сделать для разных глав (подразделов) внутри одного документа. Я бы хотел сделать так, что бы QA, на пример, мог быстро найти только те разделы, которые касаются имеено этой команды. Т.е им не надо читать всю доку, а только нужные отфильтрованные разделы. В свою очередь, разработчики, могли бы отсортировать нужный им контент документа по своим тегам.

Это возможно?

Заранее спасибо

Tuesday, April 22nd, 2014
8:44 am
[pushistis4e]
Изучение английского языка
Коллеги, здравствуйте.

Изучаю английский язык, чтобы в будущем сменить работу на более высокооплачиваемую. С литературой проблем вроде бы и нет, но мне бы очень хотелось взглянуть на живые результаты такого труда в нашем деле. На данный момент просто наугад ищу всякие руководства и мануалы, мол, "iPhone 5 guide" или некая "system of integration manual". Не поделитесь ли примерами, пожалуйста? =)

Также некоторые коллеги советуют изучить следующие руководства:
- Microsoft manual of style
- Techwriting handbook
- Techwriting guidelines

Может, у вас есть дополнения к списку?

Большое спасибо.
Sunday, February 9th, 2014
2:30 am
[aka_author]
Проектировщикам "железа" и техническим писателям в "железячных" фирмах



Разработка и оформление конструкторской документации радиоэлектронной аппаратуры: Справочник / Э. Т. Романычева, А. К. Иванова, А. С. Куликов и др.; Под ред. Э. Т. Романычевой. — 2-е изд. перераб. и доп. — М.: Радио и связь, 1989. — 448 с.: ил.

Многие нормативные ссылки в этой книге устарели. В частности, у многих стандартов появились более новые версии (хотя обозначения, например, 2.105 сохранилось).

Объясняется разница между формуляром и паспортом.

ГОСТ 34 на момент издания этой книги еще не существует.

Конкретной ссылки, как и в предыдущем посте, не даю, поскольку Интернет в этом отношении переменчив. Ищется поисковиками.

СодержаниеCollapse )
Sunday, January 26th, 2014
3:34 pm
[aka_author]
Тогда о чем: о снах, о книгах
Коллеги интересуются, нет ли у меня "военного метагайда" в электронном виде. К сожалению, нет, хотя, возможно имеет смысл его оцифровать.

Зато есть две другие книги.


Гримм

Феллер, Полторак
Гримм С. Дж. Как писать руководства пользователей ЭВМ: Пер. с англ. — М.: Радио и связь — 160 с., ил. Феллер М. Д., Полторак Ю. Л. Составление текстовых производственных документов. — М.: Издательство стандартов, 1990. — 144 с.


За Феллера и Полторака спасибо А. Литвинову, который рассказал мне об этой книге.

Извините, ссылки не даю, поскольку они то появляются, то исчезают, ссылка, поставленная сегодня, может оказаться пустой через месяц. Но если вы потратите 15 минут на поиск гуглояндексом, то найдете. (Или пишите в личку.)
Friday, December 6th, 2013
9:47 pm
[lutik_sun]
Файл справки для Android
Привет пишущему народу! Я тут неожиданно оказалась перед необходимостью написать справку для приложения под андроид, а я отродсь такого не писала. Гугл скоро меня забанит за тупые запросы, по кр мере ничего дельного я пока не нашла. Может, кто писал, подскажете, что почитать для начала, ведь не первый же я техпис, которому нужно изваять таку красоту :)

Заранее огромное спасибо!
Saturday, November 2nd, 2013
1:32 am
[yu_kagarlitsky]
Tuesday, April 23rd, 2013
3:12 pm
[aka_author]
Information Energy 2013
Коллеги, если у кого-нибудь есть желание и возможность.

13-14 июня в городе Утрехте (Нидерланды aka Голландия) состоится конференция Information Energy 2013. Основные темы — CMS, DITA, XML, в общем, управление контентом в разных видах и с разных точек зрения.

Рабочий язык конференции — английский.

Сайт конференции: http://informationenergy.org/?lang=en

Небольшое интервью с организатором конференции: http://www.philosoft.ru/wim.zhtml.
Monday, April 15th, 2013
11:33 am
[aka_author]
Памятка по стилистике технического текста
Памятку можно скачать в формате PDF, распечатать, прикрепить на стенку и т. п.

Saturday, April 13th, 2013
5:03 pm
[drbotkin]
Wiki vs Confluence
И все-таки Wiki или Confluence? Как определить, что лучше и что использовать? На первый взгляд, идеи похожи. Но только на первый?

Вот мои полюсы для Confluence (чего нет, или хуже в Wiki)
1) Лучшая (native) интеграция с Jira.
2) Более качественный импорт/экспорт PDF и MS Word.
3) Возможность импорт/экспорт HTML и XML.
4) Возможность "мапить" элементы изображения на другие топики.
5) Возможность индексировать топики по определенным тегам (словам или фразам), и затем строить таблицу (или динамический список) индексов.

Минусы:
1) Не дешево.
2) Многие «нужные» плагины могут оказаться ОЧЕНЬ не безплатными.

Что я пропустил? Какие будут мнения и/или рекомендации?

Заранее спасибо
[ << Previous 20 ]
About LiveJournal.com