Заказать звонок

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

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

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

Страницы: 1 2 3 4 5 След.
Автоназвания рисунков
 
В поле "Начинается со стиля" можно выбрать [U]стиль,[/U] с которого начнется нумерация, а не номер. По умолчанию:

- стиль Заголовок 1 - это нумерация первого уровня (в вашем примере - 8.)
- стиль Заголовок 2 - нумерация второго уровня (8.1, 8.2 , 8.3 и пр. )
- стиль Заголовок 3 - нумерация третьего уровня (8.1.1, 8.1.2, 8.1.3....)


Потому когда вы выбираете Заголовок 2 для Рисунка 8.2.-1 рисунки по всему документу будут нумероваться в рамках заголовков второго уровня.



Если хотите отдельную нумерацию в рамках каждого раздела, то есть под заголовками второго уровня - рисунки 8.1-1, а под заголовками третьего уровня рисунки 8.1.1 -1, то вам придется создать отдельные стили для Названий рисунков ,сейчас у всех названий рисунков один стиль - "Название объекта".

Кто утверждает программные документы
 

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

В  нашей компании в рамках договоров с Заказчиком всегда предусмотрена  передача документации, поэтому заполняем поле 2 и справа (Заказчик), и  слева (мы). Поле 6 никогда не заполняем, как-то так сложилось, что  подписи ставят только директора. Документов тоже много, но мы готовим  на партию документов один Лист утверждения. Составлять один Лист на  несколько документов можно согласно разделу 6 ГОСТ 2.105-95 (на который ссылается ГОСТ 34.602-89. Мы тоже разрабатываем ПО, но используем ещё 34-ую серию гост).

Мини-Гипербатон, Встреча в Яндексе (2 доклада+общение)
 
Встречи, посвящённые работе с текстом. Мероприятия пройдут 12 и 13   декабря в cанкт-петербургском и московском офисах Яндекса   соответственно.  
В программе два доклада сотрудников компании — Ремесло техписателя: приемы и методы, Как улучшить справку: наши экспирименты.
Участие бесплатное, но число мест в залах ограничено, поэтому необходимо зарегистрироваться.
Для всех, кто не сможет присутствовать, позднее выложат видеозаписи докладов.

https://events.yandex.ru/events/hyperbaton/12-13-dec-2016/#desc
Разрыв страницы
 
Помимо разрыва следующей страницы нужно ещё колонтитул с номером страницы подправить:

Разрыв следующей страницы (так ты создашь новый раздел после разрыва) +  двойной клик на колонтитуле с ненужным номером страницы> на вкладке "Конструктор" отожми кнопку "Как в предыдущем разделе"
ТЗ, Оценочная стоимость в ТЗ
 
Вы правы, оценку затрат указывают в документе Технико-экономическое  обоснование (ТЭО). Чтобы убедить руководителя сошлитесь на ГОСТы, в  которых расписано содержание этих документов.

Вам стоит найти  ГОСТы своей сферы деятельности, вот у нас на разработку  автоматизированных систем есть [URL=http://techwriters.ru/services-for-technical-writers/gosts-and-standards/gost/gost_detail.php?ELEMENT_ID=353]34.602-89[/URL] (ТЗ) и [URL=http://techwriters.ru/services-for-technical-writers/gosts-and-standards/gost/gost_detail.php?ELEMENT_ID=336]24.202-80 (ТЭО)[/URL].
DITA xhtml, DITA xhtml
 
Если бы кто-то знал ответ, то не ответил бы -  я после пары месяцев сама еле разобрала что спрашивала  :) , но задачу решила!


[B]На всякий случай переформулирую вопрос: [/B]как посредством DITA -OT сгенерировать html-справку с содержанием и формой поиска


[B]Ответ: [/B]Подключить к проекту плагин tocj (для содержания, он по умолчанию есть в DITA-OT) и плагин htmlsearch (для формы поиска, его нужно скачать из группы DITA в Yahoo).
Инструкция по подключению плагинов здесь - [URL=https://groups.yahoo.com/neo/groups/dita-users/conversations/topics/28687]https://groups.yahoo.com/neo/groups/dita-users/conversations/topics/28687[/URL]

Вид документа для описания отчета, К какому типу отнести документ?
 
rh3b, у нас отчетов много и разработан отдельный документ - Альбом отчетных форм (там и параметры отчетов и описание полей). Если отчет один, то я бы добавила его в руководство/ инструкцию.

А об изменениях функционала - да, в Release Notes (История версий).

Ranaloc, попробуйте при каждом удобном случае напоминать о том что ежемесячно выходит Relese Notes (до идиотизма, пряники всем кто запомнил).
Расширяем штат Технических Писателей!, Требуется технический писатель – грамотный, заинтересованный в работе и профессиональном развитии.
 
Требуется технический писатель – грамотный, заинтересованный в работе и профессиональном развитии (на проекты разработки и внедрения биллинговых систем для организаций в ЖКХ и ресурсоснабжающих компаний).

Обязанности:  [LIST]
[*]Разработка и актуализация документации по проектам компании (инструментами MS Word, Dr. Explain, DITA).
[*]Автоматизация процесса разработки документации.
[*]Внедрение и разработка внутренних регламентов (интерфейс, глоссарий, релизная политика).
[*]Правка технических документов и информационных статей.
[/LIST] Требования: [LIST]
[*]Хорошее знание MS Word (умение работать с шаблонам и стилями).
[*]Опыт разработки инструкций/ руководств пользователей.
[*]Опыт работы с системами управления версиями.
[*]Высокая грамотность.
[*]Желательные навыки: знание ГОСТ 34, 19, РД 50-34; опыт разработки документации по принципу единого источника; опыт работы с Enterprise Architect.
[/LIST] Условия: [LIST]
[*]Интересные задачи, работа среди профессионалов;
[*]Комфортный современный офис в БЦ в пешей доступности от метро Белорусская/Савеловская;
[*]Белая заработная плата, ДМС (поликлиника и стоматология), нормированный рабочий день;
[*]Возможность карьерного роста и сертификации за счет компании.
[/LIST] Адрес-Москва, улица Бутырский Вал, 68/70с1

 Ссылка на hh.ru – [URL=https://hh.ru/vacancy/17204363?query=%D0%BB%D0%B0%D0%B1%D0%BE%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B8%D1%8F%20%D0%BF%D1%80%D0%BE%D0%B3%D1%80%D0%B0%D0%BC%D0%BC%D0%BD%D1%8B%D1%85%20%D1%80%D0%B5%D1%88%D0%B5%D0%BD%D0%B8%D0%B9]https://hh.ru/vacancy/17204363[/URL]
Изменено: TechW - 01.07.2016 14:33:46
Четвертый Гипербатон (4 июня, суббота), Очередная конференция для технических писателей от Яндекса
 
Тоже смотрела онлайн! Меня наоборот эта конференция порадовала докладчиками из других компаний.
Запомнился второй доклад - Новосибирская компания о подборе персонала и своем жизненном опыте.
Советую посмотреть рубрику "открытый микрофон" о проф.стандарте технических писателей, интересно было послушать об опыте использования яндекс-метрики в chm и неприятных последствиях.

Ну а так - да, всё те же инструменты, тот же опыт, те же лица :)
DITA pdf формат
 
Добрый день!

К сожалению практики не было, но теоретически возможен вариант с таблицей: в файле static-content.xsl в блоках <xsl:template  name="insertFrontMatterOddHeader"> для титульного листа, <xsl:template name="insertBodyOddHeader"> для всех остальных  страниц. В static-content-attr.xsl настроите атрибуты таблиц.

Исходники, то есть сами файлы static-content и пр. лучше не трогать, а делать всё в кастомизации ( DITA\plugins\org.dita.pdf2\Customization, а то при обновлении версии DITA всё потеряете, да и вообще так удобнее и правильнее).


И как это Вы [U]просто рисуете[/U]?
Если вы создадите чертежный штамп будете просто герой! Сообщите что выйдет.
Конференция ProКонтент посвящена вопросам создания контента для пользователей (интерфейсы, обучающий контент, техническая документация и другое)., Конференция ProКонтент
 
Да, и всех порадовали игры во время докладов и подарки самым активным -  фирменные  рюкзаки (какому-то счастливчику дали рюкзак за харизматичное  слушание  hi-hi-hi ) .
По-моему им удалось создать более приятную атмосферу, чем на Гипербатоне Яндекса.

Среди гостей был один интересный старичок, который на все имел свое мнение и то веселил всех, то раздражал. Он за великий и могучий русский язык. И периодически, к моей радости, он поправлял иноземные слова докладчиков на исконно-русские   :)


 
Конференция ProКонтент посвящена вопросам создания контента для пользователей (интерфейсы, обучающий контент, техническая документация и другое)., Конференция ProКонтент
 
Рекомендации? Так держать! Приятно смотреть - стараются и любят свое дело, делятся знаниями.

В конференциях -  побольше бы практического опыта и хорошо было бы во вступлении рассказать об общем порядке работы (а то ребята выходили, каждый рассказывал о своем отделе и было непонятно как они все связаны, как налажен процесс работы).
 
Конференция ProКонтент посвящена вопросам создания контента для пользователей (интерфейсы, обучающий контент, техническая документация и другое)., Конференция ProКонтент
 
Не плохо, по-моему.
Честно говоря нового ничего не узнала, но своеобразный толчок, ну или вдохновение -  получила.
Все темы по большей части сводились к тому как правильно подавать информацию. Доклад о видеороликах вызвал особый интерес у публики, наверное, из-за очаровательных докладчиц.
Интересно было узнать про опыт Лаборатории, про то как справлялись с  трудностями. Интересно, но не очень полезно, Касперский - большая компания и их опыт не перенести на маленькие организации (вроде моей). Там на каждый чих - свой сотрудник.
Некоторые темы (например, про интерфейс или "зачем документировать то, что известно") были пустые какие-то. Так и не поняла что хотели сказать докладчики (как будто вышли пошутить). Не исключено что я была недостаточно внимательна :)

Обещали выложить материалы, говорили про то, что это конференция - часть какой-то большой программы конференций. Я так и не смогла ничего найти (((
Использование сокращений, Если есть список сокращений, в тексте используются только сокращения?
 
Насколько я знаю, подобные правила не определены стандартами. В некоторых ГОСТ есть упоминания о том, что в перечне сокращений следует располагать термины в алфавитном порядке или в порядке использования.

Если есть список сокращений, то я  
1) редко использую "далее" (только в особых случаях - для важных терминов)
2) по тексту использую и сокращение и полное название
Каков порядок присвоения дополнительной нумерации документов с одинаковыми обозначениями?
 
[QUOTE]elecman написал:
Каким нормативным документом производится присвоение дополнительной нумерации документов с одним обозначением (что должно стоять ПМ1 или ПМ-1 или ПМ-01 или ПМ.1)?[/QUOTE]
Не знакома с ГОСТами на оборудование, но для Автоматизированных Систем Управления (программного обеспечения) есть такой ГОСТ 34.201-89. Согласно нему "[I]Порядковые номера документов одного наименования (2знака) присваивают, начиная со второго, и отделяют от предыдущего обозначения точкой[/I]". То есть если бы у вас была АСУ, то код был бы АБВГ.123456.789[B].ПМ.02 [/B]у второго документа и АБВГ.123456.789[B].ПМ [/B]у первого.

Но, повторюсь ещё раз, это стандарт только для АСУ и  "[I]Настоящие правила не распространяются на документы, правила обозначения которых регламентированы государственными стандартами других систем документации[/I]", попробуйте найти свой ГОСТ :( .


DITA xhtml, DITA xhtml
 
Как прикрепить блок содержания к каждому топику?
Сейчас на xhtml выходе общий файл index.html, который разделен на два фрейма: левый- содержание, правый -контент, по ссылкам содержания меняется контент.
Как разделить на фреймы каждый топик?
ЧТЗ и ДПЗ, какой документ подготавливается первым
 
ЧТЗ - первым, ДПЗ - вторым (согласно стадиям разработки ПО: сначала Техническое задание, потом Технический проект, к которому относится пояснительная записка).
Стадии разработки см. в ГОСТ 34.602-89 или ГОСТ 19.102-77 ([URL=http://www.rugost.com/index.php?option=com_content&view=article&id=95:gost-34-601-90-avtomatizirovannye-sistemy-stadii-sozdaniya&catid=22&Itemid=53]http://www.rugost.com/index.php?option=com_content&view=article&id=95:gost-34-601-90-avtomatizirovan...[/URL], [URL=http://www.rugost.com/index.php?option=com_content&view=article&id=49:19102-77&catid=19&Itemid=50]http://www.rugost.com/index.php?option=com_content&view=article&id=49:19102-77&catid=19&Itemid=50[/URL]).
ЧТЗ и ДПЗ, какой документ подготавливается первым
 
Ovin, подскажите, а  что Вы под ДПЗ подразумеваете (ведомость держателей подлинников?)?

Порядок формирования документов иногда указан в том же ТЗ (глава "Состав и содержание работ" или "Требования к документированию").
Актуализация требований к системе, Интересен ваш опыт
 
Почему никто не отвечает? Мне тоже интересно, поделитесь пожалуйста!!!

Расскажу, как у нас:

Если необходимо внести изменения в уже подписанные Заказчиком документы, то согласно ГОСТ 34.602-89 мы выпускаем "Дополнение №.. к ТЗ.." (в нем указываем только изменения). По ГОСТУ можно также протоколы об изменениях составлять, но я не смогла узнать что они из себя представляют. Результат - у вас есть один первый документ и несколько дополнений к нему.
Помимо этого, мы, внутри компании, каждый квартал выпускаем новую версию документации, которая совпадает с версией ПО. Вот в этих версиях документы  полностью новенькие, без дополнений. Так, при появлении нового Заказчика мы передаем ему один документ, а не кучу дополнений.

Так сложилось, что документы мы формируем только для Заказчиков, для отчетности. А  наши вольные разработчики не работают с ними, им выдают требования по кусочкам.  И по этим кусочкам, задним чичслом пишется ТЗ (по уже реализованному функционалу).
"Исповедальня" для техписа, Пожалуйтесь на жизнь, а вас пожалеют и дадут совет как жить дальше)
 
Сначала хотела создать отдельную тему, попросить совета, но что уж там...закончилось исповедью:

Я разрабатываю полное руководство, которое "отталкивается" от
интерфейса + разрабатываю, по мере необходимости, технологические
инструкции (по бизнес-процессам) + подумываю об инструкциях типа
"Быстрый старт".

Но пользователи ничего не хотят читать, им бы только картинки смотреть, да сопли пускать - детский сад!
PDF. Выравнивание рисунков по центру
 
Ой, все прекрасно, код указанный выше работает, у меня были другие ошибки (прочла повнимательнее log-файл).
PDF. Выравнивание рисунков по центру
 
Подскажите, пожалуйста, как автоматически выравнять рисунки по центру (что такое понаписать в xsl-шаблоне)?

В учебнике DITA for Print есть пример редактирования в commons.xsl  блока <xsl:template match="*" mode="placeImage"> (само собой в кастомизации):[CODE]<xsl:template match="*" mode="placeImage">
       <xsl:param name="imageAlign"/>
       <xsl:param name="href"/>
       <xsl:param name="height"/>
       <xsl:param name="width"/>
<xsl:choose>
  <xsl:when test="not(@align)">
  <xsl:call-template name="processAttrSetReflection">
               <xsl:with-param name="attrSet" select="concat('__align__', 'center')"/>
               <xsl:with-param name="path" select="'../. ./cfg/fo/attrs/commons-attr.xsl'"/>
           </xsl:call-template>
  </xsl:when>
  <xsl:otherwise>
  <xsl:call-template name="processAttrSetReflection">
               <xsl:with-param name="attrSet" select="concat('__align__', $imageAlign)"/>
               <xsl:with-param name="path" select="'../. ./cfg/fo/attrs/commons-attr.xsl'"/>
           </xsl:call-template>
  </xsl:otherwise>
</xsl:choose>
...остальное без изменний...<fo:external...
[/CODE]
Попробовала, выходит ошибка "Failed to compile stylesheet".

Поискала на англоязычных форумах, там пишут что примеры в этом учебнике непонятно для какой версии Диты (попробовала на DITA OT 1.7 - та же ошибка).

Может есть ещё  какой вариант? А то как-то не хочется ручками каждый рисунок выравнивать.
Изменено: TechW - 10.08.2015 18:57:42
Вопросы и ответы
 
Подскажу только про XMLMind: Инструменты > Проверить правописание, окно редактирования - в правой части.
Вопросы и ответы
 
Краткие ответы:
1. проверка орфографии есть (в качестве не уверена)
2. самой настраивать не приходилось, знаю что можно и сложно  в rtf. Как - также как и другие форматы, при помощи кастомизации шаблонов xsl (да, с помощью плагинов DITA).
3. ответ в личном сообщении
Макрос нумерации рисунков (с исключениями)
 
Я давно использую макрос, который создали  пользователи форума. Это макрос для автоматической нумерации рисунков, за исключением тех, под которыми есть надпись - Диаграмма.
Вот он:[CODE]Sub FindUncaptionedShape()
Dim oCap As CaptionLabel, iShp As InlineShape, TmpRng As Range, TmpStr As String
For Each oCap In CaptionLabels
 TmpStr = TmpStr & CaptionLabels(oCap) & " "
Next
   Selection.HomeKey Unit:=wdStory
With ActiveDocument
 For Each iShp In .InlineShapes
   Set TmpRng = iShp.Range.Words.Last
   With TmpRng
     Do While Len(.Text) = 1
       .MoveEnd wdWord, 1
       .MoveStart wdWord, 1
     Loop
     
     If InStr(TmpStr, .Text) = 0 Then
       iShp.Range.InsertCaption Label:="Рис.", TitleAutoText:="InsertCaption1", _
               Title:="", Position:=wdCaptionPositionBelow, ExcludeLabel:=0
           Selection.ParagraphFormat.Alignment = wdAlignParagraphCenter
     End If
   End With
 Next
End With
Dim b As Boolean
b = True
   Selection.Find.ClearFormatting
   Selection.Find.Replacement.ClearFormatting
Do While b = True
   With Selection.Find
       .Text = "^pДиаграмма"
       .Replacement.Text = ""
       .Forward = True
       .Wrap = wdFindAsk
       .Format = False
       .MatchCase = True
       .MatchWholeWord = False
       .MatchWildcards = False
       .MatchSoundsLike = False
       .MatchAllWordForms = False
   End With
   Selection.Find.Execute
b = Selection.Find.Found
If b = True Then
   Selection.MoveLeft Unit:=wdCharacter, Count:=1
   Selection.HomeKey Unit:=wdLine
   Selection.EndKey Unit:=wdLine, Extend:=wdExtend
   Selection.Delete Unit:=wdCharacter, Count:=1
End If
Loop
   Selection.WholeStory
   Selection.Fields.Update
End Sub
[/CODE]А теперь прошу помощи добавить ещё одно исключение: если рисунки идут подряд (между ними и пробела нет), то нумеровать следует только последний рисунок.
Подскажите пожалуйста
Страницы: 1 2 3 4 5 След.

Рейтинг@Mail.ru