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

[QUOTE]Сергей Панченко пишет:
если вы никогда этого раньше не делали, есть большая вероятность, что у вас это не получится.
[/QUOTE]Это акушер в роддоме определяет? ))))
"Таааак, кто тут у нас... Этот не сможет никогда работать удаленно, этот не сможет быть водителем, а этот не имеет слуха"  wall-smile

[QUOTE]TechW пишет:
Каждая надпись повторяется на титульном листе ровно столько раз, сколько в документе топиков (выявлено экспериментальным путем).
[/QUOTE]
В документе несколько ditamap?
vrm  указан несколько раз??

Тогда уж с наступающим 2027 годом. Совсем скоро

[QUOTE]tech_writer_1 пишет:
Atlassian Confluence не советую, у нас там внутренняя "документация" ведётся, похоже на большую свалку, некрасиво.
[/QUOTE]Так надо наводить порядок, чтобы не было свалки. В любой системе можно развести свалку.

Внешняя тоже может вестись в конфлюенсе. Архитектура его позволяет настраивать  на разный манер.

А завтра день защиты информации..

Идейку подкинуть? Легко!    


1) Технические характеристики    

2) Компактность    
3) Малая вероятность ошибок  

Это обычный HTML. Проблема в том, что сама страница справки не содержит навигацию, она всего лишь подгружается в правый фрейм.

А просто изменить стандартный CSS нельзя?
Для PDF CSS не применяется, можно свободно его редактировать

[QUOTE]techwriter пишет:
Ты можешь сколько угодно упираться в своем предположении, что все можно описать словами.
[/QUOTE]Я не упираюсь. Я реально не могу понять, какова ценность: а) наличия формулы в документации в принципе; б) формулы в текстовом виде, а не в картинке.
Никогда не сталкивался. Для чего-то реально существует модуль MathML. Но для чего он, для меня это загадка.

Погуглил, нашел несколько примеров, но везде в них формулы сделаны в виде картинок. Такое ощущение, что это прикол какой-то )

[QUOTE]techwriter пишет:
И повторю вопрос: ты для картинки где будешь формулу брать?
[/QUOTE]
[QUOTE]techwriter пишет:
Тебе надо написать примеры ввода формул в математическом редакторе, в котором используется свой язык.
[/QUOTE]Ты отвечаешь сама на свой вопрос.

Кому это нафик надо ?   wall-smile

Чем эта формула поможет пользователю/разработчику?




Даже если нужна, на картинке она круче смотрится, не поплывет ничего никуда, не перенесется, не сломается.

[QUOTE]techwriter пишет:
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов.
[/QUOTE]У меня был проект по разработке телематической платформы, где нужно было описать API модуля "расчетов", к которому должны обращаться сервисы сторонних разработчиков. И документация предназначалась именно для сторонних девелоперов, которым нужно понимать к чему обращаться, откуда ждать результаты расчетов и как все считается. Всего около тысячи операций, соответственно по несколько формул в каждой операции расчета.
Ни одной формулы не использовал, т.к. не математик и не факт, что читающий эти формулы поймет. Нарисовав формулу, совсем не очевидно, что она будет правильно осознана. А когда словами пишется, что на что умножается/делится/прибавляется/отнимается, какие коэффициенты применяются и откуда они берутся - вопросов не возникает.

[QUOTE]techwriter пишет:
Потому что ты писал только документацию к бизнес-приложениям и никаким другим.
[/QUOTE]Откуда такая информация? :o Тебя жестоко обманули :)

[QUOTE]techwriter пишет:
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов.
[/QUOTE]Это такое же бизнес-приложение как и все остальные, только направленность у него не так широка, как большинство редакторов.

[QUOTE]techwriter пишет:
[QUOTE] ADVANCED пишет:
[QUOTE] techwriter пишет:
[QUOTE] ADVANCED пишет:
А почему не сделать формулы картинкой ?
[/QUOTE]Угу. Очень "удобно".
[/QUOTE]в кавычках - сарказм?
А что не удобного то? Я вот ни разу не встречал формулы в документации и ни разу не писал их. В учебниках видел только. В картинке формула будет или нет, не важно.
Не думаю что формулу нужно часто редактировать. Что неудобного? Скриншоты ведь делаются в виде картинок, а не в виде куска html с кнопочками и надписми
[/QUOTE]Потому что ты писал только документацию к бизнес-приложениям и никаким другим.
Например, у меня был фрилансерский проект по разработке онлайн-справки по работе с математическим онлайн-редактором. У этого редактора была куча функционала, который позволял писать и редактировать научные и технические статьи. Он был предназначен для преподавателей технических вузов. Возникает вопрос, совсем нетрудоемко, на твой взгляд, в этом случае отдельно писать формулы, их скриншотить и потом вставлять в текст? И, кстати, в чем ты их планируешь составлять? В "неудобном" ворде?
[/QUOTE]Этот пример не позволил мне понять зачем в онлайн-справке формулы. Но раз уж необходимость есть, то формулы создаются в описываемом "математическом онлайн-редакторе". С них делается скрин и вставляется в справку.
Пусть программа хоть траектории марсохода считает, если справка к программе должна содержать формулу, которая создается в этой программе, то надо ее там (в описываемой программе) создать и снять скрин. Если формула взята из какого-то нормативного акта, то ее нужно отскринить и вставить как картинку не задумываясь, т.к. менять ее нельзя (на то он и акт).

[QUOTE]writer пишет:
[QUOTE] Elanor пишет:
но, повторюсь, ждать супер-пупер дизайн-макета от писателя я бы не стала.
Писатель ответственен за текст, за то, как правильно его структурировать, использовать нужные стили, а про закругление кнопочек в веб-форме - это отнюдь не писательское занятие.

[/QUOTE]Согласен на 100%, ибо дизайнер сделает это лучше.
[/QUOTE]Т.е. можно спокойно удалять ветки форума, в которых обсуждается "как сделать фон", "как заменить иконки", "как настроить формат" и искать ответы на форумах программистов и дизайнеров??? hi-hi-hi

[QUOTE]Марина пишет:
[url=http://techwriters.ru/forum/user/13391/]ADVANCED[/url] , резюмирую Ваши посты в этой теме.

Если техписатель пишет ТЗ, проектную документацию, маркетинговые материалы или методички, это на него навесили не его работу. Оформляет, редактирует, приводит к читаемому виду документацию, написанную программистами и аналитиками - тем более, почти приравнивается к мытью полов вместо уборщицы.

А вот настройка формы кнопок - его обязанность, если ему это не нравится, он просто лентяй, который не хочет развиваться.
[/QUOTE]Если техписатель пишет ТЗ, проектную документацию, маркетинговые материалы или методички, это на него навесили не его работу, либо он изъявил желание так работать, выполняя функции аналитиков, т.к. ему интересно профессионально развиваться.

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

[QUOTE]techwriter пишет:
[QUOTE] Elanor пишет:
Мне кажется, основная работа техписа - написать понятную пользователю книгу/справку/нужное дописать, которая была бы подспорьем в освоении программы. Сделать это согласно установленным стандартам, и чтобы конечный текст отображал истинное положение вещей.
[/QUOTE]Полностью согласна. Основная задача технического писателя - писать. Умение хорошо подавать материал тоже большое искусство :)
[/QUOTE]Это половина успеха :) Надо сделать так, чтобы написанное кто-то смог прочитать.


Написать толмут в 1500 страниц, который никто никогда не откроет и не распечатает, а если откроет, то не найдет там то что нужно - это косяк технического писателя.

[QUOTE]techwriter пишет:
В идеале, в отделе документирования, на мой взгляд, должно быть разделение по ролям: технические писатели, редакторы и дизайнеры. Тогда и текст не будет требовать редакторской правки и выглядеть все будет достойно.
[/QUOTE]Человечество думает как автоматизировать процессы, чтобы освободить часть специалистов, увеличить скорость работы и уменьшить затраты.


ТОлько что выстроились три кита DITA OPEN TOOLKIT (и подобных):
[LIST][*]Дизайнер сделал стиль и свободен, к этому вопросу больше не возвращаемся[*]Редакторы заменяются спелчекерами и доп.проверками кода исходников.[*]Писатель тупо вводит текст в нужной разметке, не заморачиваясь тем, что будет на выходе.
[/LIST]

[QUOTE]Elanor пишет:
А вот всякие круглые кнопочки, высоты и всевозможное макетирование в веб-справке - это больше к веб-дизайнеру задание.
[/QUOTE]
[QUOTE]Elanor пишет:
Мне кажется, основная работа техписа - написать понятную пользователю книгу/справку/нужное дописать, которая была бы подспорьем в освоении программы. Сделать это согласно установленным стандартам, и чтобы конечный текст отображал истинное положение вещей.
[/QUOTE]Компьютер включать/выключать будет сисадмин, вводить текст оператор, проверять ошибки и соответствие стандартам - нормоконтроль и т.д. Для онлайн-хелпа пригласят веб-дизайнера, верстальщика, администратора серверов для размещения всего этого. Для печати документации наймут специалистов печатного дела, верстальщиков и поддержку принтеров... Чай принесет и на телефон ответит [I]персональный секретарь технического писателя[/I] :) Программист самостоятельно пришлет фрагменты кода для наглядных примеров, граф.дизайнер придумает красивые надписи для примечаний, а психологи расскажут как грамотней расставлять пояснения в тексте, чтобы не травмировать психику читателя.
Не работа, а сказка! [B]Не надо развиваться[/B], вокруг много специалистов своего дела, которые всегда рады помочь :)
Писатель - тонкая творческая личность, ему нужно только ловить вдохновение и продиктовывать мысли под запись оператору-наборщику текстов. Нечего портить нежные ручки об замусоленную клавиатуру и грызть казенный карандаш   :D  

Ну и в конце месяца бухгалтер лично принесет зарплатную ведомость, а инкассатор наличные, чтобы не разбираться в "сложном" ПО банкомата (он инкассатор, это его работа)

[QUOTE]writer пишет:
Вот мы и пришли к тому, что самый потолок карьеры Технического писателя
[/QUOTE]Писатель может стать аналитиком, потом руководителем проекта, потом замом начальника IT-департамента, начальником IT-департамента, генеральным директором, замом минкомсвязи, министром/депутатом/членом фракции/губернатором, президентом страны :D
Конституционные права есть, никто не ограничивает. От человека зависит и его отношения к жизни и развитию.

[QUOTE]writer пишет:
Вот мы и пришли к тому, что самый потолок карьеры Технического писателя - Начальник отдела документирования компании "IBM"
Аминь!
[/QUOTE]IBM - пример. Есть еще множество оргомных щедрых корпораций типа Google, Microsoft и т.п.
Яндекс я бы не отнес к таковым, т.к. знаком с их предложениями по работе, зарплатами :)

[QUOTE]techwriter пишет:
[QUOTE] Виктор Фигурнов пишет:
Заказчик говорит, что онлайн-документация ему в принципе нравится, но эта кнопочка должна быть с закругленными углами, этот ярлычок вкладки другой высоты, промежуток между панелями должен быть узкий, должны быть такие-то кнопки, которые то-то делают, и т. д. Будете отвечать, что ничего этого делать не умеете?
[/QUOTE]Виктор, а что сложного в закруглении углов, изменении высоты и проставлении промежутков между панелями?
[/QUOTE]techwriter, и правда, это же с молоком матери передается ))

[QUOTE]Марина пишет:
Тысячу раз имхо, прошу прощения, если кого-то обижу, но профессия "технический писатель" довольно узкая, в ней сложно как-то глубоко развиваться. И, главное, надо ли? Потолок по зарплате наступит довольно быстро, потолок в карьере - "начальник отдела документирования"? - очень редкая должность.
[/QUOTE]Это в каком населенном пункте?
В МСК, например, ограничений нет. Спрос на профессионалов есть всегда.  ЗП  упирается только в знания тех или иных инструментов и технологий.
Даже английский язык не так важен, как знание и навыки работы с SQL, знание протоколов обмена данными и т.п.  

Карьера? По мне карьера технического писателя это переход от проекта к проекту. Чем больше обязанностей и шире круг задач, тем успешнее карьера, при условии, что справляешься со всем.
Запись в трудовой начальника отдела документирования в шарашкиной конторе хуже, чем рядового технического писателя в IBM или Новатэк.

Мозг не нужен, ходи себе сдавай, главное диету соблюдать и не болеть :) и работать не надо, плюс льготы всякие