Статьи
Обработка документации как кода от Mastercard
В последние годы фраза «документация как код» стала широко известна в сообществе технических писателей, особенно среди писателей, специализирующихся на программной документации. По сути, «документы как код» означает создание документации с использованием некоторых из тех же инструментов и процессов, которые используются разработчиками программного обеспечения
Подробнее
Документирование в разработке ПО
Одним из болезненных вопросов в разработке ПО всегда был и остаётся процесс документирования этой самой разработки. Вам доводилось приходить на проект, который делают уже пару лет, но, при этом, вы никак не можете с ним разобраться, потому что из документов есть одно техническое задание, да и то написано в самом начале и не отражает и половины функционала системы?
Подробнее
Прощай ГОСТ РД-50! Признан недействующим: РД 50-680-88, РД 50-34.698-90 и Р 50-34.119-90
Приказом Росстандарта № 216 от 12.02.2019 постановление Государственного комитета СССР по стандартом от 27 декабря 1990 г. № 3380 признано недействующим на территории Российской Федерации.
Подробнее
Нас ждут новые ГОСТы? Объявлен конкурс на разработку новых стандартов для разработки технической документации
Сбербанк - АСТ объявил конкурс на разработку стандартов в области информационных технологий, включая КСАС.
Подробнее
Шрифты Times New Roman, Arial и Courier New попали под санкции
Неожиданное решение приняла компания Monotype Imaging, которая запретила российским государственным учреждениям использовать шрифты Times New Roman, Arial и Courier New.
Подробнее
О чем был шестой Мини-гипербатон: Метрики эффективности документации?
Подробнее
Человек получивший награду за непревзойдённое мастерство в области технической документации
Бьёрн Страуструп, это тот самый человек который придумал язык программирования С++. Родился он 11 июня 1950 в датском городе Орхус.
После окончания школы поступил в Университет Ааргус на отделение компьютерных технологий. В 1975 году окончил его и получил степень магистра.
В дальнейшем продолжил свое образование в Кембриджском университете Англии.
Doc-To-Help
Doc-To-Help - это инструмент для технических писателей, позволяющий написать текст документации один раз, а затем сформировать на его основе множество вариантов, которые могут различаться форматами, комплектацией, целевой аудиторией и тому подобным. Такая методика подготовки документации называется Single source publishing, то есть публикация из единого источника. Для разработки технической документации существует множество других средств - Adobe RoboHelp, Help & Manual, DocBook и так далее. Важнейшим отличием Doc-To-Help является простота его использования - он не требует от пользователя знания какого-либо специального языка разметки и позволяет использовать в качестве редактора документов Microsoft Word.
Подробнее
Готовим скриншоты для документации в GIMP
Как известно, неотъемлемой частью профессионального программного продукта является качественная документация. А документация, в свою очередь, немыслима без иллюстраций. В большинстве случаев иллюстрации представляют собой скриншоты, которые должны быть не только красивыми и информативными, но и единообразно оформленными. Последнее важно, если над разными разделами документации работают разные специалисты (технические писатели).
Подробнее
Atlassian Confluence - новое программное обеспечение для технического писателя!
Atlassian Confluence — тиражируемая вики-система для внутреннего использования организациями, занимающимися проектами по разработке программного обеспечения, в частности, будет востребована отделами документирования программных продуктов
Подробнее
Метрологическая экспертиза конструкторской и технологической документации
Основные цели и задачи метрологической экспертизы конструкторской и технологической документации на сегодняшний день определяет нормативный документ МИ 1325–86 "Методические указания. ГСИ. Метрологическая экспертиза конструкторской и технологической документации. Основные положения и задачи".
Подробнее
Знакомьтесь - профессия Технический писатель
Для многих сейчас уже не секрет, что сфера IT-технологий является одной из наиболее развивающихся сфер в современном мире. И никто не сомневается, что эта сфера продолжит свое развитие, поскольку мы живем в век высоких технологий, и любой механизм и устройство будут совершенствоваться, чтобы отвечать запросам своего времени. Осмотрите вашу комнату, и вы обнаружите множество устройств, без которых вы уже теперь не можете представить свою жизнь, устройства, которые уже стали частью нашей жизни.
Подробнее
Кто такие технические писатели?
Что такое “технический писатель” представляют себе немногие. Вкратце рассмотрим, кто такие технические писатели вообще, и чем конкретно они занимаются. Популярной эта профессия стала в первую очередь, благодаря развитию информационных технологий. Компании-разработчики нового оборудования, приборов, высокотехнологичных изделий, программного обеспечения, построения комплексных сетей в настоящее время нуждаются в специалистах, способных доступно и толково объяснить пользователям и заказчикам, как со всем этим работать. В инженерно-конструкторской сфере технические писатели востребованы в меньшей степени: частных фирм-производителей, имеющих собственные конструкторские отделы немного, а в государственных НИИ и конструкторских бюро технической документацией обычно занимаются инженеры.
Подробнее
Немного о стандартах документации
Документация – такая штука, к которой мало кто питает тёплые чувства: скучно, занудно, однообразно. И, тем не менее, иногда не возникает сомнений в её необходимости: ведь кому-то после вас этим пользоваться или, тем паче, модифицировать. И тогда появляется вопрос: как сделать документацию правильно?
Предпроектная документация: что это и почему она так важна?
Среди моих знакомых нет ни одного, кто любил бы писать технические задания или что-то вроде этого. Чертить на салфетках планы захвата вселенной, собирать лэйауты из разноцветных стикеров, шлифовать концепцию в голове и на словах – это все любят и умеют делать, а вот сесть и как следует записать…
Меня, например, любой шаблон серьезного документа погружает в глубочайшую тупку.
Как разрабатывать техническую документации в Open Source проектах?
Хотя эта идея на первый взгляд может показаться глупой, упрощенной и слишком общей, я хотел бы предложить стандартый способ документирования проектов с открытым исходным кодом. Я знаю, что каждый проект индивидуален и моя идея уже вызвала у вас улыбку, но я надеюсь вы поймёте меня, если прочитаете этот небольшой пост.
Подробнее
Документация – экономия времени или его бесполезная трата?
Я хочу сразу оговориться, что данная статья не преследует собой цель раскрыть все вопросы создания и ведения технической документации, которая может потребоваться системному администратору. Здесь я лишь попытаюсь очертить круг тех документов, которые так или иначе приходится писать любому работнику IT отдела, если в его задачи входит докуметирование.
Подробнее
Как слышат русскую речь иностранцы
Русский язык — это звуки, которые издавала бы кошка, посади ее в коробку, полную мраморных шариков: писк, визг и полная неразбериха.
/Вильям-Ян, дизайнер, Нидерладны/
Мне всегда казалось, что русский язык — это смесь испанского с округлым «р», французского, в который добавили «ж», и немецких грубых звуков.
/Джереми, учитель, США/
Утекшие персональные данные в России все чаще используются для «кражи личности»
Аналитический центр компании InfoWatch представил результаты глобального исследования утечек информации за первую половину 2014 г. Впервые в отчет включены не только инциденты, произошедшие по вине внутренних нарушителей, но и утечки, ставшие результатом хакерских атак, сообщили CNews в InfoWatch.
Подробнее