7 правил написания технической документации мирового класса

Как можно проверить какой блок питания стоит на компьютере

Блок питания – одна из самых важных составляющих персонального компьютера. Его нельзя приобретать по остаточному принципу или вовсе наугад. От него зависит надежность функционирования всего остального «железа». Поэтому во многих случаях требуется точно знать возможности БП, для чего нужны сведения о его типе.

Для простого использования ПК знание типа и нагрузочной способности блока питания необязательно. Для офисной работы или домашнего применения знать эта информация бесполезна. Другое дело, если источник питания вышел из строя и его надо менять – на точно такой же или аналогичный по характеристикам.

Иная ситуация – когда компьютер модернизируется с установкой дополнительного «железа» или с полной его заменой. В этом случае надо проверить свой блок питания — можно ли оставить его для дальнейшей работы, или его нагрузочной способности не хватит, и придется подбирать замену.

Скука убивает

Это правило является, по-видимому, самым трудным для формализации и самым важным по необходимости соблюдения. В современном мире интернета действует много сил, борющихся за внимание вашего читателя. Скучное стандартное описание работать не будет. При любых обстоятельствах ваш читатель желает, чтобы было увлекательно и информативно. Поэтому, если ваш текст неясный или неинтересный, то читатель просто щёлкнет пресловутую кнопку «Далее» и перейдёт на другую веб-страницу или на другую ТВ-программу или на свою страницу в Фейсбуке.

Самый простой путь, который я нашёл для пробуждения интереса у читателя, состоит в том, чтобы интересно было мне самому. Я всегда прилагаю значительные усилия, чтобы написать такую статью, которую сам хотел бы прочитать. Я стремлюсь получать удовольствие от того, что пишу. Если мне скучно, то заскучает и читатель. Если я запутался, то запутается и читатель. Если меня не волнует рассматриваемая тема, то читатель, тем более, не взволнуется. Всё очень просто!

Мне нравится юмор, поэтому я стараюсь сделать мои литературные технические «творения» забавными, но, конечно, без ущерба для ясности. Пытаюсь разговаривать с читателем, а не поучать его. Пишу о делах, которые, действительно, имеют значение для меня. Широко использую иллюстрации, чтобы предотвратить неясность для читателя.

И снова, всегда стараюсь сделать процесс чтения увлекательным. Я всегда помню, что пишу в конкурентной среде. Имеется множество контента, стремящегося привлечь внимание читателей. Таким образом, мой совет по правилу № 1: если ваши тексты будут интересны вам, то они будет интересными и для читателя.

⇡#Dr.Explain 5.3 – полуавтоматические руководства с готовыми аннотациями

• Разработчик: Indigo Byte Systems.
• Операционная система: Windows.
• Распространение: shareware, от 7 500 рублей.
• Русский интерфейс: есть.

Dr.Explain не может похвастаться таким современным интерфейсом, как Clarify, однако у этой программы есть свои уникальные особенности. Пожалуй, самое главное – это автоматизация процесса создания технической документации. Просто укажите окно приложения или же веб-страницу сервиса, которые нужно описать, и Dr.Explain самостоятельно создаст скриншот, проанализирует все элементы интерфейса, добавит выноски и даже подпишет их там, где это возможно.

Если в интерфейсе захватываемого приложения встретится меню, Dr.Explain обязательно раскроет его, сделает снимок всех уровней подменю и добавит выноски для каждого элемента. Более того, все скриншоты будут помещены в проект Dr.Explain с сохранением структуры документа (то есть, скажем, основное окно будет в разделе 1, раскрытое меню – 1.1, а пункты подменю – 1.1.1, 1.1.2 и так далее). Таким образом, вся скучная и монотонная работа выполняется в автоматическом режиме, и пользователю остается только добавить описание всех элементов интерфейса. Понятное дело, что структуру документа можно изменять, перемещая пункты, добавляя новые и удаляя ненужные.

Еще до создания скриншотов можно настроить множество параметров, которые касаются изображений. Например, есть возможность задать место размещения выносок, стиль аннотаций, определить вариант генерирования имен файлов (в соответствии с заголовками разделов или их номерами).

Если ранее работа над документацией велась в другом приложении, можно легко импортировать проект и программу. Dr.Explain поддерживает импорт документов CHM, Word, HTML, HLP, RTF, TXT, XML.

Совместная работа над документацией организована через сервис Tiwri.com, созданный специально для обмена данными между пользователями Dr.Explain. Из окна программы можно загружать текущий проект на сервер, отсылать изменения, сбрасывать правки, отслеживать историю.

Для экспорта готовой документации предлагаются форматы CHM, Word, HTML и PDF. При этом еще до выполнения экспорта можно увидеть, как мануал будет выглядеть в одном из этих форматов. Перед экспортом нужно не забыть перейти в настройки проекта и задать дополнительные параметры. Например, при сохранении документа в PDF можно указать ключевые слова, автора, заголовок, тему и формат, настроить колонтитулы и нумерацию страниц, а также создание закладок для разделов. При экспорте в HTML есть возможность настроить карту сайта, добавить комментирование для пользователей Facebook * и Disqus, включить показ панели с кнопками социальных сетей, указать данные FTP-сервера, на который будет загружен проект.

Наконец, стоит обратить внимание на то, что Dr.Explain – продукт отечественных разработчиков, поэтому вполне ожидаемо, что в нем можно найти полноценную поддержку русского языка.

Что такое техническое задание и технический проект?

Как правило, всю техническую документацию необязательно прописывать до начала разработки программного обеспечения. Чаще всего современные IT-проекты создаются по методологии Agile, а работа над ними ведется по спринтам, что позволяет писать документацию параллельно с процессом разработки.

Используейте ApiX-Drive для самостоятельной интеграции разных сервисов между собой. Доступно 350+ готовых интеграций.

• Автоматизируйте работу интернет магазина или лендинга
• Расширяйте возможности за счет интеграций
• Не тратьте деньги на программистов и интеграторов
• Экономьте время за счет автоматизации рутинных задач

Однако есть несколько документов, которые в идеале должны быть подготовлены до старта разработки ПО: к ним относится техническое задание (ТЗ) и технический проект (ТП).

Техническое задание является ключевым предварительным документом, в нем представлено общее описание и назначение программы, ее бизнес-цели, предполагаемый объем работ, а также порядок этапов разработки, оценки и приемки ПО. ТЗ составляется бизнес-аналитиком после переговоров с заказчиком, поэтому в нем нужно точно и подробно зафиксировать все его требования и видение будущей программы. При необходимости, также его обсуждают с участниками команды-исполнителя проекта: разработчиками, дизайнерами, проект-менеджерами и т.д. Фактически, это выраженная в документальной форме постановка задачи.

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

Говоря простым языком, если техническое задание отвечает на вопрос «что нужно сделать?», то технический проект – на вопрос «как это сделать?».

Техническая документация согласно ГОСТ Р 54089-2010

Еще одно очень милое, краткое и емкое определение техдокументации — «Совокупность конструкторской и технологической документации, используемой для изготовления, испытания, эксплуатации и ремонта изделия [из 3.1.12 ГОСТ Р 54089-2010]».

1. «Верить в наше время нельзя никому. Порой даже самому себе. Мне — можно!» (c) Мюллер ?;
2. Определения терминов, применяемых в технике в целом, следует искать не в сетевых словарях и энциклопедиях, а ТОЛЬКО в нормативных документах, поскольку указанные Интернет-ресурсы практически не модерируются специалистами предметной области, поэтому добавлять и редактировать их содержимое может кто попало и как попало;
3. Сетевые словари и энциклопедии пригодны лишь для быстрого поиска ссылок на эти самые нормативные документы. Т.е. использовать их можно только в качестве отсылочных баз данных;
4. В этих самых нормативных документах тоже порой встречаются разночтения, но они, по крайней мере, УЗАКОНЕНЫ государством, следовательно — с государства и спрос (ежели чего). Перефразируем известный слоган г-на Караулова: «Отвечаем за каждое свое слово. Кровью. Ростехрегулирования!» ?;
5. И самое главное — НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ НЕЛЬЗЯ ССЫЛАТЬСЯ на квазитерминологию из сетевых источников в технических документах. Документы с определениями из . педий вызывают в лучшем случае ироничное к ним отношение, а профессиональная подготовленность разработчиков таких документов — серьезные сомнения, см. п. 2 перечисления.

• для поиска соответствующей случаю нормативной документации достаточно сделать запрос в любой поисковой системе с ключевым словосочетанием «гост термины и определения» — откроется список терминологических стандартов. Это быстрый, но не отличающийся особой пертинентностью способ. Более того, терминология частенько содержится в ГОСТах, которые могут быть и не найдены поисковыми машинами по указанным ключевым словам;
• более сложным и запутанным является поиск терминологии в Общероссийском классификаторе стандартов. Но результат поиска по запросу «термины и определения» в подходящем разделе ОКСа будет точным и исчерпывающим по своей полноте.

Copyright © «Техническая документация» 2008 — и ныне и присно, и во веки веков!

Заимствуйте наши материалы с блеском! При воспроизведении материалов портала tdocs.su установка активной гиперссылки на источник (адрес веб-страницы с заимствованной публикацией) обязательна ☠

Связь по эл. почте admin @ tdocs . su (без пробелов) или в форме Контакты.

nanoCAD

Платформа: Windows
Плюсы: Может создавать профессиональные проекты и чертежи в различных форматах.

nanoCAD — это легкое приложение с простым интерфейсом, мощными инструментами черчения и проектирования, совместимостью с родным DWG и открытым API.

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

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

Что категорически запрещено делать

Начнем с наиболее важной части. Обозначим то, что категорически запрещено делать с ПК (это самая обширная часть правил):

• Заслонять отверстия для вентиляции на системном блоке.
• Использовать сетевой фильтр, в который включен компьютер, для электропитания других приборов.
• Допускать резкие удары и встряхивания оборудования.
• Деформировать провода и кабели и допускать физическое воздействие на них (скручивать, придавливать, завязывать и т. д.).
• Ставить на компьютер и периферийные устройства различные предметы.
• Вставлять и вынимать кабели, идущие к периферийным устройствам, при работающем компьютере (исключение — USB-устройства). По правилам безопасности машину необходимо полностью обесточить — отключить силовой электрический провод от сети.
• Включать нагревательные и другие бытовые приборы рядом с ПК.
• Допускать воздействия разного рода на оборудование: сидеть на нем, пинать ногами, поджигать, проливать воду, сок, кофе и другие жидкости, рассыпать мелкие предметы и фрагменты пищи (список можно продолжать до бесконечности).
• Самостоятельно инсталлировать, удалять, изменять ПО и настройки сети без специальных знаний.
• Разбирать оборудование на детали (комплектующие).
• Использовать при удалении пыли с экранов спирт и мокрую ветошь.
• Аварийно завершать работу ПК с помощью кнопки RESET либо отключением электропитания. (Только в экстренных случаях) Правильный алгоритм: «ПУСК»→«Завершение работы».

Все рекомендации обязательно нужно исполнять, особенно, если оборудование находится на гарантии.

Контроль исполнения заданий

Для контроля за прохождением документов по маршрутам, а также за исполнением заданий, в Search используется система приоритетов заданий и установка контрольных сроков их выполнения. Обеспечивается возможность слежения за ходом исполнения, за движением документов в процессе маршрутизации — у кого из пользователей в данный момент находится задание, прочитано ли оно

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