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

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

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

Страницы: Пред. 1 2 3 След.
Профессиональный стандарт «Технический писатель» 2012, Обсуждение первой редакции "Профессионального стандарта для Технических писателей»
 
[QUOTE][B]гена [/B]А кто разрабатывает то его и что это значит для нас?[/QUOTE]Автор документа misha

[QUOTE]Очень много забавных, если не сказать смешных моментов, например:
Технический писатель владеет английским языком, как минимум, на уровне чтения
технической документации со словарем. Отсутствие технической документации на
родном языке при наличии таковой на английском языке не может рассматриваться
в качестве препятствия к освоению им какой-либо программы или технологии.[/QUOTE]
То есть, знаешь японский, но не знаешь английский - отказать в присвоении гордого звания "технический писатель"! ))

Или вот:
[QUOTE]Техническому писателю присущи формы поведения и навыки организации и пла-
нирования собственной работы, которые ожидаются от служащего любого совре-
менного предприятия. В частности, он способен соблюдать этикетные требования,
связанные с информированием коллег о своих планах и результатах, совещаниями,
телефонными переговорами, деловой перепиской, принятые в той культурной сре-
де, в которой он работает.[/QUOTE]
К слову, "любые современные предприятия" ох как разнятся между собой, как по "этикетным требованиям", так и по другим параметрам - и стандарта на этот счёт нет. И вряд ли когда либо будет. Что же касается подразумевающихся в данном конкретном абзаце принципов "общего менеджмента", то их нужно конкретно прописывать.

читаю дальше...
А ещё по "внесеню изменений" подскажите
 
Серия 34 может иметь лист регистрации изменений.
Второй лист документа (первый - титульный) - Табличка "лист изменений" примерно следующего содержания:
[attachment=0:3jl2isy6]Лист_рег_изменений_ТЗ.png[/attachment:3jl2isy6]
О профессии технический писатель, карьерный рост технического писателя,
 
[quote="nofeb":2byrnwzd]Я не из тех, кто тщательно изучает форум, прежде чем создать новую тему. [/quote:2byrnwzd]
плохой системный аналитик всегда сразу изобретает что-то "новое", вместо того, чтобы изучить "старое"

[quote="nofeb":2byrnwzd]как технический писатель связан с системным- или бизнес-аналитиком?[/quote:2byrnwzd]
поиск вам в помощь
вот например с первой же страницы запроса
[url=http://planetahr.ru/publication/2411]http://planetahr.ru/publication/2411[/url]
или вот
[url=http://www.sql.ru/forum/actualthread.aspx?tid=882629]http://www.sql.ru/forum/actualthread.aspx?tid=882629[/url]
или ... ))

удачи.
как описать соединение типа «точка-точка»
 
[quote="puhata":1m2cjs5k]вот эту [url=http://ru.wikipedia.org/wiki/%D0%A1%D0%B5%D1%82%D1%8C_%D1%82%D0%BE%D1%87%D0%BA%D0%B0-%D1%82%D0%BE%D1%87%D0%BA%D0%B0]http://ru.wikipedia.org/wiki/%D0%A1%D0% ... 0%BA%D0%B0[/url][/quote:1m2cjs5k]

В данном случае "Прямое соединение".

Введите [url=http://www.classes.ru/dictionary-english-russian-electr-term-68306.htm:1m2cjs5k]здесь[/url:1m2cjs5k] point-to-point - будут предложены варианты в зависимости от области применения выражения.
Помогите нaйти "мaстер подобий" (прогрaмм тaкую)
 
Цитата
когда нахамил мне в первом же своём сообщении в этой теме
бревно вытащи из своего глаза, а потом уже на сучки в чужих указывай.
посмотри внимательно на моё первое сообщение в этой теме, а потом на свой "фыркающий" ответ.
Ищу удаленную работу техническим писателем
 
про Word если пишете, то нужно его знать больше, чем умеет обычный гражданин: работа с шаблонами, массовое применение стилей для документов в десятки-сотни страниц, операции с большими блоками текста и т.д., и т.п.
Word - хороший инструмент, но им нужно уметь профессионально пользоваться.
Помогите нaйти "мaстер подобий" (прогрaмм тaкую)
 
Цитата
Цитата

[url=http://yandex.ru/yandsearch?country=ru&text=Beyond%20Compare&clid=1909644&lr=213:3tfoc1hh]на, почитай. спешал фо ю все результаты исключительно на русском.[/url:3tfoc1hh]
Сопляк. Ты сначала [url=http://www.google.com/search?q=%22Araxis+Merge%22&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:ru:official&client=firefox:3tfoc1hh]ЭТО[/url:3tfoc1hh] прочитай, а потом уж свою варежку разевай на людей, которые тебе в отцы годятся
я так понял, тебе нужны "шашечки, а не ехать".
больше воплей и ора, юнат, больше - так ты точно сойдёшь за взрослого и, авось, кто-нибудь откликнется. если захочет общаться в подобной стилистике.

PS: beyond compare и araxis merge - очень похожи.
Помогите нaйти "мaстер подобий" (прогрaмм тaкую)
 
Цитата
Цитата
малолетний тролль, тебя в гугле забанили?

Beyond Compare даже не попробовал, а туда же - фыркать.


Цитата
Попробовал Beyond Compare. Да, первое впечатление от возможностей сравнения было в пользу Beyond. Особенно понравилось, как внизу на всю длину экрана показываются две сравниваемые строки. Это очень удачная находка - часто этого не хватает в Araxis Merge.
Но тут дело дошло до редактирования сравниваемых файлов. И все - Beyond Compare сразу же отпал из рассмотрения! Это же каменный век! Технологии двадцатилетней давности - ну кому сейчас нужен строчный редактор? В общем, дальше я даже сравнивать не стал, не интересно уже.
(с) [url=http://forum.ru-board.com/topic.cgi?forum=5&topic=1244&start=20#4:styqhmy2]ОТСЮДА[/url:styqhmy2]
на дату своей цитаты посмотри, клоун малолетний.
ты бы ещё цитату из 50-х годов привёл в духе: какие-такие компакт-диски от фирмы "Союз"? что это? только грампластинки "Мелодия"!
уж несколько лет, как 3-яё версия появилась с обновлением функционала.
а последний релиз так всего лишь как с полгода вышел.
там можно много чего под себя настроить - чтобы сравнивало, как надо.

[url=http://yandex.ru/yandsearch?country=ru&text=Beyond%20Compare&clid=1909644&lr=213:styqhmy2]на, почитай. спешал фо ю все результаты исключительно на русском.[/url:styqhmy2]
Какие документы должны иметь лист согласования
 
[quote="Ася":3jm6wx32]Подскажите, пожалуйста, нужно ли для протоколов предварительных и приемочных испытаний делать лист утверждения/согласования?[/quote:3jm6wx32]
Обязательно. Это в том числе юридически обусловлено для закрытия проекта/объекта.

[quote="Ася":3jm6wx32]Где вообще можно посмотреть список документов для которых нужно делать лист утверждения (например, нужен ли он для руководства пользователя?)[/quote:3jm6wx32]
Жёстких требований нет. Всё обусловлено постановкой бизнес-процессов и юридической поддержкой. За консультацией нужно обращаться к бизнес-аналитику организации, для которой вы выполняете работы.
И, кстати, за полный перечень необходимых документов для сопровождения процесса/проекта отвечает он (или руководитель проекта), а не технический писатель.
Для Руководства пользователя в подавляющем большинстве случаев лист утверждения/согласования не требуется. Но может и потребоваться для фиксации определённой информации, которая должна быть отражена - как правило это бывает, когда не проводится обучение по эксплуатации сданного объекта, а просто передаётся док-ция по работе с ним.

[quote="Ася":3jm6wx32]Как правильно оформлять протоколы испытаний: они подписываются только представителями заказчика-участниками комиссии или на титульном листе должны быть и руководителя-Исполнителя? Исполнитель не принимает участия в испытаниях, все только сотрудниками заказчика делается.[/quote:3jm6wx32]
В протоколах испытаний отражаются только те, кто непосредственно принимал участие (проводил испытания, сверял данные, принимал результаты испытаний и т.п.) Кто непосредственно не задействован, те не указываются.

[quote="Ася":3jm6wx32]Кто должен подписывать отчет об обучении сотрудников заказчика, если мы передаем им руководство пользователя и рекомендации, а обучаются они сами?[/quote:3jm6wx32]
Никто.
Обучения не проводилось, поэтому отчёта о нём быть не может. Передаётся рук-во пользователя - это можно зафиксировать - см. выше.

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

Beyond Compare даже не попробовал, а туда же - фыркать.
Помогите нaйти "мaстер подобий" (прогрaмм тaкую)
 
Beyond Compare попробуйте.

в linux простая команда sdiff сравнит два файла как есть по строкам
Как правильно писать "ввода/вывода" "открыть-закрыть" и пр.
 
[quote="ADVANCED":4z6k3g9z][quote="Konstantin":4z6k3g9z]Дефис употребляется, когда используются синонимы, обозначающие один объект либо описываются атрибуты, относящиеся к одному объекту.

По вашим примера:
ввода-вывода
установки-снятия
[/quote:4z6k3g9z]
это не синонимы, а антонимы. [/quote:4z6k3g9z] есть случаи, когда синонимы. а у вас антонимы относятся к "описываются атрибуты, относящиеся к одному объекту"

[quote="ADVANCED":4z6k3g9z]Как "они" относятся к одному объекту понятно, а вот как "обозначают один объект" - не очень.[/quote:4z6k3g9z]
пример обозначения одного объекта синонимами:
оператор-тестировщик
Как правильно писать "ввода/вывода" "открыть-закрыть" и пр.
 
Дефис употребляется, когда используются синонимы, обозначающие один объект либо описываются атрибуты, относящиеся к одному объекту. Дефис используется без пробелов.

Если акцент на равноценности использования, но по смыслу объекты разные, то дефис не используется. я для таких случаев на практике использую "/". Пробелы также не использую, т.к. объекты не разделяются, а указывается на их единство в описываемом использовании. Пример с И/ИЛИ в этом плане нагляден.

По вашим примерам:
ввода-вывода
установки-снятия
но
GPS/ГЛОНАСС
одному/нескольким
Нам нужен хороший технический писатель
 
Вот [url=http://techwriters.ru/forum/viewtopic.php?f=25&t=1431:1pqjfxlq]эта тема[/url:1pqjfxlq] на эту же вакансию?
Или ваша студия набирает несколько технических писателей в разные отделы?
Хлэп! Посоветуйте инструмент для трассировки печатных плат
 
Вот [url=http://kazus.ru/forums/showthread.php?t=16868:ialfiuu3]здесь[/url:ialfiuu3], например, варианты. А вообще поисковики - незаменимы в таких случаях..
Бесплатные программы для создания документации.
 
[quote="chaosteorist":1em4e8qj]Так же пробовал использовать в своей работе dokuwiki, но возникли проблемы с интеграцией. Нужна именно html или web справка.[/quote:1em4e8qj]
добавлю, чтобы знали.
есть плагин, позволяющий выгружать из docuwiki в html формат
Написание руководства пользователя к ПО в разработке
 
Хороший вариант для пока несуществующего отчёта - нарисовать таблицу, где расписать названия и значения полей, варианты заполнения.
FAQ для технического писателя
 
Форум - сам сплошное ЧАВО, а на сайте такой раздел был бы полезен: не все люди идут на форумы. Им нужно сразу и конкретно.
иногда выбрасывает из форума
 
у кого проблемы, почистите кэш браузера и кукисы - и будет вам счастье.
Re: Внимание всем форумчанам! Всем чистить куки!
 
[quote="writer":15s3k5jt]Почистите на своих браузерах [b:15s3k5jt]cookes[/b:15s3k5jt]! Если не знаете как, спрашивайте![/quote:15s3k5jt]
[ctrl]+[F5]
[ Закрыто] Должен ли тех.пис. иметь большой опыт инженера?
 
[quote="ADVANCED":kgathm4k][b:kgathm4k]Это писатель знать может, но не должен.[/b:kgathm4k][/quote:kgathm4k]но если он это знает, то его проф. скилл существенно вырастает.
я изначально в этой теме и написал, что инженерный опыт будет только подспорьем: хуже не будет, а вот плюсов куда больше.
Комиксы как новый стиль пользовательской документации
 
[url=http://ru.wikipedia.org/wiki/%D0%98%D0%BD%D1%84%D0%BE%D0%B3%D1%80%D0%B0%D1%84%D0­%B8%D0%BA%D0%B0:99dja8rs]Из википедии(тыц):[/url:99dja8rs]
[i:99dja8rs]Инфогра́фика (от лат. informatio — осведомление, разъяснение, изложение; и др.-греч. γραφικός — письменный, от γράφω — пишу) — это графический способ подачи информации, данных и знаний.
Спектр её применения огромен: география, журналистика, образование, статистика, технические тексты. Инфографика способна не только организовать большие объёмы информации, но и более наглядно показать соотношение предметов и фактов во времени и пространстве, а также продемонстрировать тенденции...[/i:99dja8rs]
Комиксы как новый стиль пользовательской документации
 
[quote="writer":34w0m94x][quote="Konstantin":34w0m94x]Кстати, очень интересная тема, пересекающаяся с "инфографикой".[/quote:34w0m94x]
А можно про это подробнее? Знаю что СМИ используют инфографику, но в разработке документации не слышал такого
[/quote:34w0m94x]
ну как же не слышали?! )) просто вы этим модным словом такие картинки не называли.
сейчас приложу пару простых примеров из собственной док-ции.
Комиксы как новый стиль пользовательской документации
 
Кстати, очень интересная тема, пересекающаяся с "инфографикой".
Мне кажется, что док-ция в виде комиксов продуктивна только для конечного пользователя и если она описывает не сложный объект.
Например, я встречал в виде комиксов инструкции для детской зубной пасты - детям самое то!
Проблема в том, что для комикса нужен какой-никакой сюжет и лаконичность выражений, а сложную техническую структуру запихать в подобные ограничения очень сложно.
[ Закрыто] Должен ли тех.пис. иметь большой опыт инженера?
 
[quote="sudo":1eygyibm][quote="Konstantin":1eygyibm]хороший техпис заботится об удобстве восприятия того, что написал.[/quote:1eygyibm]
Не совсем согласен. Акцент должен быть не только на удобстве восприятия, а на том, чтобы пользователь любого пола и возраста мог, читая руководство, тупо, последовательно, по шагам выполнять требования руководства и прийти к заранее определенному руководством результату. Не стоит ждать от пользователя понимания того, что он делает, достаточно того, чтобы он [b:1eygyibm]тупо все сделал[/b:1eygyibm], следуя четким указаниям руководства, и чтобы у него [b:1eygyibm]просто все получилось[/b:1eygyibm] :)[/quote:1eygyibm]
ага, я всегда пишу пользовательскую документацию "для дебилов" - т.е. чтобы по шагам мог всё сделать даже первоклассник.
но при этом добавляю теоретическую часть различной степени детализации,  в зависимости от спектра пользователей - чтобы заинтересованный читатель мог глубже понять описываемый предмет.

[quote="ADVANCED":1eygyibm]Но компаниям выгоднее нанимать техписа, чтобы он занимался документацией и с него спрашивать потом, чем заставлять толкового программиста с высокой оплатой писать документацию вместо кода.[/quote:1eygyibm] вы значит, совершенно не знаете, что такое ITIL. Есть типы документации, которую пишут в первую очередь программисты, а техпису(или разработчику технической документации) доверяется только причёсывание этих доков к единому формату, красивостям, системам документооборота и т.п.
например, "спецификация на ПО" - это своего рода паспорт программы, в котором отражается в хронологическом порядке, что происходило с программой с момента её создания и до последнего изменения. Используется принцип "разумной бюрократии", когда любое законченное изменение кода вносится в спецификацию сразу же - что позволяет работать над программой нескольким программистам одновременно, например если каждый пишет свой блок.
Кстати, такие "спеки" очень хорошее подспорье при создании уже той док-ции, за которую отвечает техпис, начиная с ТЗ проекта/продукта и заканчивая рук-вом пользователя или инструкцией применения.
Кроме того, программист высокого класса всегда в коде пишет комментарии - чтобы его последователю-разработчику не приходилось тратить время на "обратный инжиниринг".
В общем, в корпоративных средах, программисты даже если этого сильно не любят, но вынужденны писать не только код, но и его описания для различных нужд - а иначе их очень сильно начинают "не любить" другие программисты, работающие с этим же продуктом.

[quote="Доктор ТуамОсес":1eygyibm]
а я не тех.рис. Я разработчик КД.
А во вторых, я на форумах просто общаюсь, а не показываю образец своего стиля
а в третьих, я не тех.пис. Я разработчик новых концепций, которые сотрясут эту вселенную[/quote:1eygyibm]
не надо так нервничать. образцы стиля никто не показывает, но, как правило, каков человек, в таком стиле он и пишет - что на форуме, что на работе, что в почте и т.п.

[quote="ADVANCED":1eygyibm]Короче, тема пришла в выпендривание старых уродов-программистов, перед молодыми востребованными специалистами в документировании. :mrgreen: :mrgreen:[/quote:1eygyibm]
как бы вас это не шокировало, но вы тоже будете в глазах молодых и востребованных старым уродом, так что смотрите на тему шире и не цепляйтесь к возрасту.
Страницы: Пред. 1 2 3 След.

Рейтинг@Mail.ru