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

Как вариант: вы сейчас работаете на т.н. закрытых распределенных рынках. Т.е. когда прибыль компании не зависит от качества документации.

А если так - то зачем напрягаться?

Не все так однозначно... http://www.sql.ru/forum/154476-a/kak-rabotaetsya-v-infosistemy-dzhet По треду можно хорошо проследить историю...

Мне не совсем понятно, что вы сделали из того, что я написал в списке. Как я могу судить - из того, что я написал вы не сделали НИЧЕГО.

1. У вас на работе аналогично все медленно происходит? Если да, то срочно адаптируйтесь. Иначе в ИТ вы просто не будете успевать совсем.

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

3. Вы постоянно будете у всех спрашивать после каждого посещения компаний - что пошло не так? На тостере и sql.ru этими вопросами завален весь форум. Ознакомьтесь и потом уже задавайте вопросы - по существу.

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

https://toster.ru/tag/карьера/questions

https://toster.ru/tag/образование/questions

Вот еще ссылка: http://www.protesting.ru/qa/interview_game.html

У меня сложилось мнение, что в вашем НИИ все тихо, спокойно и медленно. Точнее, так: МЕДЛЕННО.

Список приведен в хронологическом порядке выступлений. Программа: [URL=http://2017.secr.ru/lang/ru/program/agenda]http://2017.secr.ru/lang/ru/program/agenda[/URL]

20.10.17

Управление знаниями в “Лаборатории Касперского” [URL=http://0x1.tv/20171020DK]http://0x1.tv/20171020DK[/URL]

Контент для пользователя — битва за эффективность [URL=http://0x1.tv/20171020DL]http://0x1.tv/20171020DL[/URL]

Документация как код в промышленных масштабах [URL=http://0x1.tv/20171020DM]http://0x1.tv/20171020DM[/URL]

Confluence и collaborative documentation — возможности и подводные камни [URL=http://0x1.tv/20171020DN]http://0x1.tv/20171020DN[/URL]

21.10.17

Документация — что может пойти не так. Типичные сложности и подводные камни [URL=http://0x1.tv/20171021DF]http://0x1.tv/20171021DF[/URL]

Как найти, настроить и внедрить техписателя [URL=http://0x1.tv/20171021DG]http://0x1.tv/20171021DG[/URL]

Единый источник в документации — подходит вашей команде или нет? [URL=http://0x1.tv/20171021DH]http://0x1.tv/20171021DH[/URL]

От Knowledge Acquisition к Knowledge Management [URL=http://0x1.tv/20171021DI]http://0x1.tv/20171021DI[/URL]

Автоматизация оценки качества пользовательского контента [URL=http://0x1.tv/20171021DJ]http://0x1.tv/20171021DJ[/URL]

[QUOTE]Звёздочка написал:
Спасибо, ребята, не ожидала, что так быстро откликнетесь!
Прикладываю документ к сообщению (повырезала из текста всё лишнее, т.к. в полном размере он не прикреплялся)

Конфликтуют стили "Заголовок 3" и "Нумерованный 3 уровня".
Если вам удастся их победить - настоятельная просьба описать всё по пунктам, что именно вы сделали, ибо у меня море документации, где предстоит та же проблема.

В одном из документов они как-то ужились (я тупо выставила все нужные параметры отображения и всё получилось), в других то же самое уже не прокатывает, автоматом один стиль тащит за собой другой: одному сделаешь жирный жрифт - и второй тут же ожиреет, и т.п., сколько ни настраивай. Похоже, дело всё-таки в неких настройках, о которых я не знаю.
Я самоучка по Ворду и пока далеко не его повелительница, так что буду благодарна за помощь)[/QUOTE]
А вы понимаете, что прикладывая этом пример вы прямым образом нарушаете NDA?

Вопросы по сути сказанного мной есть или нет?

И, кстати, неплохо знать английский - это не читать англоязычную литературу, а уметь писать на нем и говорить.

Прошла неделя из месяца, который я обозначил. Вы что-нибудь реально сделали за это время? Если да, то можете обозначить (без особых подробностей).

Вы сначала скажите: вам надо руководствоваться каким-то стандартом. Или, в принципе?
Если стандартов - об этом говорит стандарт.

Если в принципе, то информационные схемы деляться на группы и делается ссылка.

Это если прямо отвечать на вопрос.

Но я не вижу здесь задачи, которую вы хотите этим решить. Зачем вам выгружать?

Наиболее оптимальный вариант будет следующий:

1. Почитать про цикл разработки ПО, начиная от требований, заканчивая выкаткой (сбор и анализ требований, разработка, тестирование, деплой).
2. Почитать про разные модели разработки ПО (водопад, agile и т.п.).
3. Почитать про то, кто чем занимается в команде (например, знать, кто такой devops, product owner и что он делает).
4. Составить сравнительную таблицу средств разработки документации. И знать отличия. Плюс у вас - вы знаете, что такое S1000D или S2000M.
5. Пересмотреть видео с конференций про рахработку ПО в области технической документации. Есть бесплатные видео. В т.ч. на 0x1.tv
6. Посмотреть какой-нибудь open source проект и сделать документацию по нему (естественно бесплатно). Там уже будет ваше имя. Как делать - лучше смотреть на гидлайны Digital Ocean (https://www.digitalocean.com/community/tutorials/digitalocean-s-writing-guidelines). В итоге - у вас уже будет портфолию :)

У вас должны быть следующие знания:
- Типы и комплектность документов (не по ГОСТу - по госту вы и так знаете). Например, знать, что такое SRS
- Кто что делает в команде и кто за что отвечает.
- Знать структуру документа (опять же НЕ по ГОСТу).

Уже с этим багажом - либо подаваться на стажера, либо на Джуниора.  Имейте в виду, что у вас может быть некий провал по деньгам. Поэтому  подушка должна быть.

Есть еще вариант - слать резюме в маленькие компании, там где зарплата небольшая. Т.е. она небольшая по ИТ меркам. Думаю, что она будет больше вашей текущей в любом случае. Там, как правило, небольшие требования.

пп.1-6 при нормальных мозгах и отсутствии проблем в жизни - примерно на месяц.

Вопросы - задавайте.

P.S. Попробуйте пройти в компанию без тестовых заданий. Ваши тестовые задания - это ваше портфолию - см. выше. Как правило, у компаний с тестовыми заданиями большие проблемы с коммуникациями. Т.е. они будут оценивать не ваши навыки (объективно), а текст по их условиям (субъективно).

P.P.S  вы не обозначили город. От этого много что зависит!

Ставка для джуниоров с английским в СПб начинается от 75 т.р.

RTFM: [URL=https://daringfireball.net/projects/markdown/syntax#link]https://daringfireball.net/projects/markdown/syntax#link[/URL] ("Reference-style links...")

[QUOTE]Alex_Gur написал:
[QUOTE]Вам как надо читать документацию - ДО установки на другой машине или ВО ВРЕМЯ установки в консоли. Если ВО ВРЕМЯ, то PDF не катит. Нужен просто текст или man. Если же ДО, то пофигу какой формат будет. Ибо ДО читать можно на любой машине - хоть на смартфоне.[/QUOTE]
Мне надо, чтобы документацию читали ДО установки на той же машине Linux.
Ответ понятен.
Большое спасибо.[/QUOTE]
Думаю, что вам он не совсем понятен.

Если ДО установки на той же машине, то зависит от того, стоит там X11 или нет. Если это чистый сервер (без X11), то у вас только один вариант: README, INSTALL в чистом тексте или man pages (хотя их тоже придется ставить ДО прочтения)
Совет один: скачайте ЛЮБОЙ .tar.gz с src у любого opensource пакета (хоть с github.com, хоть с sourceforge.net) и посмотрите на файлы README, INSTALL - как они устроены, внутренняя структура и  т.п.

[QUOTE]Alex_Gur написал:
Большое спасибо, коллеги!
В целом, понятно.

Последний вопрос: можно ли оформить документацию в PDF.
То есть, будут ли читаться в Линуксе файлы PDF?[/QUOTE]
Мне кажется, вы не совсем понимаете, о чем говорите.

Есть X11, а есть CLI. Или это web-приложение, которое хостится на CLI, а читается на X11??? У вас какое приложение? Вам как надо читать документацию - ДО установки на другой машине или ВО ВРЕМЯ установки в консоли. Если ВО ВРЕМЯ, то PDF не катит. Нужен просто текст или man. Если же ДО, то пофигу какой формат будет. Ибо ДО читать можно на любой машине - хоть на смартфоне.

[QUOTE]Sofya написал:
 Текрайтер из Питера , меня не то чтобы заботит, но просто интересно, что это и как работает, учитывая, что я ничего не делаю, а значения в этих полях растут.
"Хочется быть авторитетной" - это я ради шутки написала, извините.

Город Петербург.[/QUOTE]
Я вам отписался на почту через форум. Если получили сообщение - дайте знать также почтой.

[QUOTE]Гость написал:
[QUOTE] Текрайтер из Питера написал:
В интерфейсе установки разницы - никакой.[/QUOTE]
Речь идет о стандартных пакетах установка программ в этих семействах ОС.
[/QUOTE]
Обратите внимание, что ТС об этом [B]ничего[/B] не говорил. Т.е. вы сделали вывод о чем-то, не имея на это никаких оснований, не задав ни одного уточняющего вопроса. Т.е. изначально был сферический конь в вакууме.

А ваш отвлеченный пост-вопрос
[QUOTE]А чем отличается от Windows?[/QUOTE]
принципиально имеет:
1. Множество ответов (причем множество из них будет правильно).
2. Не несет никакую смысловую нагрузку для ТС. Из вашего ответа невозможно сделать какие-либо выводы [B]применительно к вопросу[/B] ТС.
3. ТС не подводится к ответу, а отводится от него.

Т.е иными словами, ваш пост - флуд (м.б. с долей троллизма).

[QUOTE]Гость написал:
Основное и главное отличие - в интерфейсе установки.
В ОС типа Windows - это графический интерфейс (последовательность окон с полями ввода данных и выбором значений),
в ОС типа Linux - интерактивный процесс  (вывод вопроса на консоль - ввод и обработка ответа).
Соответственно, в первом случае инструкция - последовательность окон, во втором - последовательность вопросов.[/QUOTE]
Неправильный ответ.
В интерфейсе установки разницы - никакой.

Вам для примера привести Synaptic? Где там консоль?

Обратный пример: установка tzupdater у Java. Где там интерфейс?

[QUOTE]Sofya написал:
 Текрайтер из Питера , вопрос совсем не в тему, но может вы знаете - вот я тут пишу и с каждым сообщением у меня и рейтинг и авторитет в профиле растет - это просто так что ли? просто нигде не нашла правил, объясняющих, что такое эти баллы, рейтинг, авторитет и пр... Хочется быть авторитетной  [/QUOTE]
Не знаю, меня лично это не заботит.

P.S. Город у вас какой?

[QUOTE]Alex_Gur написал:
Подскажите, пожалуйста, каковы особенности оформления Инструкции по установке программы  в среде Linux .
В частности,  в каком формате  должна быть создана Инструкция по установке для среды Linux, какие указывать  системные требования  для ОС и для компьютера потребителя, каковы  типовые требования к предустановленному программному обеспечению  и др.
Спасибо.[/QUOTE]
Уточните (по вашей програме):
1. Тип продукта.
2. Это сервис (daemon) или клиентская программа, ориентированная на ввод/вывод данных.
3. Тип выпуска и релиза продукта
4. Тип распространения продукта (напрямую, электронно, на CD, через партнерскую сеть).

Т.е. нужно больше информации. Там еще много будет вопросов, но хотя бы суть понят.

Предыдущий комментарий оратора "Гость" - из серии "иногда лучше ничего не говорить".

[QUOTE]Sofya написал:
 Текрайтер из Питера , какие вы сложные вопросы задаете :-) Обо всем перечисленном я, как человек, который до сих пор работал только в ворд, имею только смутное представление. Сейчас приходится читать, изучать, искать информацию... Причем, в основном она англоязычная, а у меня с английским плоховато. Из совокупности этого и выходит, что каша в голове, это правда :-)
Я не уверена, что ответы на все заданные вами вопросы мне действительно нужны.
Про TEI слышала (вот отсюда -  [URL=https://protext.su/pro/izmenite-podhod-k-napisaniyu-kontenta/]https://protext.su/pro/izmenite-podhod-k-napisaniyu-kontenta/[/URL] ), но, по-моему, это не совсем в ту степь, куда мне надо...
Вот что я читала из основного (помимо всяких обрывков сведений из поисковика):
[URL=https://www.ibm.com/developerworks/ru/library/x-reuseinfo1/]https://www.ibm.com/developerworks/ru/library/x-reuseinfo1/[/URL]
[URL=https://habrahabr.ru/company/docsvision/blog/250917/]https://habrahabr.ru/company/docsvision/blog/250917/[/URL]
[URL=http://philosoft-services.com/docbook-basics.zhtml#ftn.id320872]http://philosoft-services.com/docbook-basics.zhtml#ftn.id320872[/URL]
[URL=http://philosoft-services.com/dita-intro.zhtml]http://philosoft-services.com/dita-intro.zhtml[/URL]
[URL=https://protext.su/pro/chto-takoe-dita-i-zachem-nam-eto-nuzhno/]https://protext.su/pro/chto-takoe-dita-i-zachem-nam-eto-nuzhno/[/URL]
На это в основном и опираюсь...
Где-то видела такую фразу: "С выходом версии DocBook 5.1 стирается разница между DITA и DocBook"...
Ссылку на стандарт DITA, которую вы привели, я, кажется, видела - вот здесь -  [URL=http://techwriters.ru/forum/messages/forum620/topic18318/message1583/#message1583]http://techwriters.ru/forum/messages/forum620/topic18318/message1583/#message1583[/URL] - была аналогичная ссылка на спецификации DITA, их, кстати, использую для формирования первого pdf-файла на основе DITA.
Про ASCIIDOC - девушка, которая со мной занимается внедрением единого источника, на прежней работе работала с ASCIIDOC, у неё остались негативные впечатления, потому решили даже не рассматривать его как вариант. К тому же это, кажется, не единый источник.

Как у нас дело идет: читали обо всем этом; составляли перечень ТЕИ, которые могут подойти; решили, что стоит сделать первый pdf документ, при составлении которого лучше поймем, как работает единый источник, как исходные файлы публиковать в готовый документ формата PDF, насколько это сложно и вообще...

Саму концепцию я понимаю, для чего это нужно, как это получается (в плане DITA, а не DocBook или чего другого - про них читала меньше). Сейчас затык с созданием pdf... точнее не затык, а просто работа - по-тихоньку создаю файлик (сейчас у меня одна карта, несколько топиков в одной папке, стили в другой папке, выходной готовый док в стандартной папке out). Ну и маячат на горизонте вопросы по организации работы с документацией вообще в компании, когда DITA уже будет внедрена. Тут даже дело не столько в DITA, а в том, что придется отказаться от Word, что смущает - а что начальство скажет? Вероятно, следующее: "Единый источник это, конечно, хорошо, но доки надо посылать в ворд, ибо заказчик так привык". Отсюда и судорожные поиски чего-то, что может на выходе дать ворд хоть в каком-то приближении. Пока "приближение" у нас одно - конвертация из pdf в word. Но конвертации недостаточно - конвертится только внешний вид документа, при этом стили не обновляются и не создаются и, вероятно, их и нельзя создавать и обновлять как ни мучайся с DITA - потому что у DITA совсем другой подход, чем у ворда...

Ох, путано написала, но уж простите :-)

Очень хочется разобраться с технологией, от неё плюсов много: новый опыт, плюс к резюме, какие-то перспективы, потому что дита используется во многих продвинутых компаниях, просто другой взгляд на разработку документации...[/QUOTE]
Вы просчитывали ЭКОНОМИЧЕСКИЕ основы использование единого источника? С этого надо было начинать.

[QUOTE]Sofya написал:
 Elena ,   Текрайтер из Питера , спасибо за проявленный интерес! Буду обрабатывать полученную информацию :-)

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

Ладно, буду еще разбираться, читать, пытаться понять, как все это должно выглядеть и как к этому прийти :-)[/QUOTE]
У вас каша в голове, вы уж извините :)

Про то, что "перестал поддерживаться" - в ноябре 2016 года вышел новый стандарт 5.1 Об этом я публиковал здесь новость.

Где читали, что нельзя использовать? Почему? Дело в том, что DocBook подход предполагает более agile метод при проектировании системы из единого источника.

Чтобы сравнить и выбрать что-либо, вам надо изучить в стандарты в первоисточнике. Сначала, конечно, будет сложновато. Но от этого никуда не деться.

Sofya, у вас как со знанием XML-related вещей? Например, вы знаете отличия между DTD и XSD? Вы знаете, что такое namespaces и чем документы с namespaces отличаются от документов без оных?

Ссылки на стандарты:

DocBook 5.1 [URL=http://docs.oasis-open.org/docbook/docbook/v5.1/docbook-v5.1.html]http://docs.oasis-open.org/docbook/docbook/v5.1/docbook-v5.1.html[/URL]
DITA 1.3 [URL=http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part0-overview.html]http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part0-overview.html[/URL]

P.S. Подозреваю, что для русскоязычной аудитории мне надо будет делать специальный детальный обзор разницы в подходах и методологии между двумя стандартами.
Кстати, заметил у поклонников DITA такую особенность. Тот, кто с ней работает на DITA совершенно не представляет о существовании других языков семантической разметки. Это как с поклонниками продукции Apple :)

Кстати, а вы знаете, что существуют другие языки семантической разметки? Есть TEI ([URL=http://www.tei-c.org]http://www.tei-c.org[/URL]), есть даже MEI ([URL=http://music-encoding.org]http://music-encoding.org[/URL]). А также MathML, как частный случай использования.

Вы знаете о существовании т.н. lightweight markups? Т.е. легких языков разметки. markdown, asciidoc, restructured?

[QUOTE]AlexeyPP написал:
Здравствуйте, уважаемые участники форума!

Кто-то сталкивался с проектом DocLine ?
[URL=http://www.math.spbu.ru/user/kromanovsky/docline/]http://www.math.spbu.ru/user/kromanovsky/docline/[/URL]

Интересует опыт использования.
Заранее благодарю!
С уважением, Алексей[/QUOTE]
А какой его смысл? Дело в том, что Single Sourcing изначально предполагает избегать повторов. А здесь, кажется (м.б. я не прав), система анализирует уже существующие повторы.

[QUOTE]Sofya написал:
Всем добрый день!

Занимаюсь внедрением технологии единого источника (ТЕИ) в своей компании. Пока в качестве ТЕИ выбрали DITA.

Возникло несколько вопросов:
1) Если до сих пор Заказчик получал документы в формате Word и перейти на другой формат будет проблематично, то можно как-нибудь настроить DITA так, чтобы итоговые документы собирались в файл с расширением doc/docx? Пока решение у нас одно: собирать в PDF, потом конвертировать в Word.
2) Насколько актуален формат RTF в DITA? Читала, что он перестал поддерживаться, но, может, кто-то для себя настроил вывод документов в RTF... Этот формат рассматривается как альтернатива формату Word.
3) После внедрения DITA как происходит проверка готовых документов? Не всем ведь специалистам компании хочется читать xml файлы, чтобы понять, корректный ли текст в итоге получится... Можно каждый раз собирать файл, который можно редактрировать, но это долго и, возможно, неудобно.
4) В связке с предыдущим вопросом - есть ли в DITA возможность сборки в формат, который позволял бы редактировать получившийся файл?
5) Не все привычные в Word штуки можно делать в DITA (по крайней мере я пока не нашла об этом информации) - например, перекрестные ссылки: как вставить ссылку на рисунок в тексте топика?..

Поделитесь опытом, пожалуйста :-) ТЕИ очень нужен...

P.S.: А может все вопросы выше легко решит DocBook? Если да, то как в общих чертах?[/QUOTE]
А вы какими причинами руководствовались, что выбрали DITA, а не DocBook. Вы понимаете разницу этих стандартов?

Давайте я уж здесь влезу в чужой монастырь (топик) и немного разбавлю докбучной информацией :)

1. Для Word у DocBook стилей есть т.н. roundtrip. Не все гладно, но нужно пробовать.

2. Вы сначала должны задать себе вопрос - зачем вам это формат. Я переформулирую. Думаю, что вам надо что-то, что можно редактировать со стороны заказчиков. так?

3. Есть замечательный XMLMind - там все, как у людей :) GUI во всем его многобразии.

4. То, что настроите, то и получите :) Т.е. все ограничивается возмоюжностью xsl и вашей фантазией.

5. Странный вопрос. Более того, можно даже выдернуть _название_ топика при сборке из другого документа и в динамике.

Вопросы по DocBook - ко мне. По DITA - к Елене :)

[QUOTE]AlexeyPP написал:
Здравствуйте, уважаемые участники форума!

В ближайшее время должны легализоваться ниже следующие проекты нормотворчества  

Проект ПП РФ «О внесении изменений в Требования к порядку создания, развития, ввода в эксплуатацию, эксплуатации и вывода из эксплуатации государственных информационных систем и дальнейшего хранения содержащейся в их базах данных информации»

[URL=http://regulation.gov.ru/projects/List/#npa=50323]http://regulation.gov.ru/projects/List/#npa=50323[/URL]

Проект Приказа Минсвязи РФ «Об утверждении Требований к составу, структуре и содержанию подлежащих разработке технической документации и документов на этапах жизненного цикла государственных информационных систем»
[URL=http://regulation.gov.ru/projects/List/#npa=60689]http://regulation.gov.ru/projects/List/#npa=60689[/URL]

Интересно ваше мнение по этим инициативам.

С уважением, Алексей[/QUOTE]
Судя по тексту - просто взяли ГОСТ 19, 34 и включили все в приказ :)

[QUOTE]'''''writer''''' Zakharenko написал:
Добрый день, Текрайтер из Питера!
К сожалению у нас нет разделения на "подписки" и "неподписки".
Рассылки приходят всем зарегистрированным на сайте пользователям. Единственная возможность отписаться, это удалить пользователя из группы Зарегистрированные пользователи, а по факту из БД сайта.
Мы не так часто рассылаем письма, по-моему последний раз, рассылали в прошлом году.[/QUOTE]
Вы ошибаетесь. Рассылка была 8-го декабря и 2 раза подряд (с разницей несколько часов).

Если никак удалить нельзя, значит эти письма у меня будут отфильтровываться в спам.

В общем, сабж.

Уже второе письмо за сегодняшний день. Почему отсутствует пункт "Отписаться"? Вы понимаете, что при отсутствии пункта отписаться подобные письма - однозначный признак спама.

Типичные признаки спама (отсюда: [URL=https://forum.kaspersky.com/index.php?showtopic=216180]https://forum.kaspersky.com/index.php?showtopic=216180[/URL])

...
2. Письма НЕ содержат ссылки типа "unsubscribe".
3. На сайте нет возможности отписаться от рассылки
...

DocBook версии 5.1 теперь является официальным стандартом OASIS.

Ссылка на первоисточник: [URL=https://www.oasis-open.org/news/announcements/docbook-v5-1-becomes-an-oasis-standard]https://www.oasis-open.org/news/announcements/docbook-v5-1-becomes-an-oasis-standard[/URL]