Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 След.
RSS
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
Выкладываем в этой теме примеры и ссылки на хорошую техническую документацию
 
Цитата
writer пишет:
Выкладываем в этой теме примеры и ссылки на хорошую техническую документацию
Ахаха...

А по каким критериям определяется что документация хорошая?  
Изменено: ADVANCED - 25.06.2014 10:53:27
 
Наверняка плохой документации больше, так что чтобы никого не обидеть, выкладываем примеры плохой документации сюда.   :)
 
По каким критериям? По своим) То что вы считаете хорошей документацией, а мы уже обсудим насколько она хороша)
 
Цитата
ADVANCED пишет:
Наверняка плохой документации больше, так что чтобы никого не обидеть, выкладываем примеры плохой документации сюда .
Плохую документацию почти каждый день приходится видеть :))
Вот, примеры хорошей технической документации действительно не помешает.
Мне нравятся туториалы, под которые придумывается персонаж комикса.
techwriter.ru.com
 
Цитата
techwriter пишет:
Мне нравятся туториалы, под которые придумывается персонаж комикса.
так , а подробнее?? :?:
 
Цитата
writer пишет:
так , а подробнее??
Например, ссылка на смешные комиксы: http://www.datamation.com/cnews/article.php/3849381/Tech-Comics-The-User-and-the-Geek.htm
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
techwriter.ru.com
 
Цитата
techwriter пишет:
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
Я делал однажды такую с дядей-полицейским (тогда еще милиционером) в главной роли  для ГИАЦ МВД, предполагалось что старые тетки так лучше воспримут и запомнят информацию. Каков был результат не знаю.  
Изменено: ADVANCED - 26.06.2014 11:37:00
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
Я делал однажды такую с дядей-полицейским (тогда еще милиционером) в главной роли для ГИАЦ МВД, предполагалось что старые тетки так лучше воспримут и запомнят информацию. Каков был результат не знаю.
А ты рисовать умеешь? Я, вот, нет :))
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
Я делал однажды такую с дядей-полицейским (тогда еще милиционером) в главной роли для ГИАЦ МВД, предполагалось что старые тетки так лучше воспримут и запомнят информацию. Каков был результат не знаю.
А ты рисовать умеешь? Я, вот, нет )
Рисовать интерактивно только. Не как художник кистью на полотне...
 
Цитата
ADVANCED пишет:
Рисовать интерактивно только. Не как художник кистью на полотне...
Я и интерактивно рисовать не умею :)))
techwriter.ru.com
 
Мной когда-то была разработана АНКЕТА ДЛЯ ОБСЛЕДОВАНИЯ  ОБЪЕКТА ЗАКАЗЧИКА.

Может кому надо????

скачать: doc ~ 400 kb

РS: примеров хорошей документации полно... только мне на пиво не хватает и есть желание удалить её используя метод Гутмана.
 
Цитата
Орлов Андрей пишет:
Мной когда-то была разработана АНКЕТА ДЛЯ ОБСЛЕДОВАНИЯ ОБЪЕКТА ЗАКАЗЧИКА .

Может кому надо????

скачать: doc ~ 400 kb

РS: примеров хорошей документации полно... только мне на пиво не хватает и есть желание удалить её используя метод Гутмана.
Что за метод Гутмана?
За анкету огромное спасибо!!!
 
Цитата
writer пишет:
Что за метод Гутмана?
Метод Гутмана :)
 
Цитата
ADVANCED пишет:
Цитата
writer пишет:
Что за метод Гутмана?
Метод Гутмана
Метод Гутманаалгоритм безопасного удаления данных (например, файлов) с жесткого диска компьютера. Метод разработан Питером Гутманом и Коллином Пламбом. Метод состоит из 35 проходов, ориентированных на уничтожение записей, закодированных методами MFM и различными модификациями RLL.
ссылка в википедии
 
Как-то довелось поработать в одной организации и руководитель отдела в бывшем, нехороший человек, редиска - Буторин Д.С., поручил техписа (меня) рисовать схему данных XSD без предварительного обучения и инструктажа...

Цитата
Вообщем, я сам пытался разобраться: пробовал и искал... Для ознакомления предоставляю документ Cognitive Technologies Ltd. Единый формат файлов. Версия 1.0
 
скачать документ "Cognitive Technologies Ltd. Единый формат файлов. Версия 1.0"
 
Сегодня случайно наткнулась:
https://www.firebase.com/how-it-works.html
techwriter.ru.com
 
Спасибо всем, продолжаем собирать примеры!! По возможности загружайте на сервер TechWriters.ru т.к ссылки на файлы, хранящихся на файлообменники потом пропадают :(
 
Вчера купил проектор и обнаружил там самую потрясающую инструкцию, которую я видел. Собственно, вот и она:





Больше там ничего не было)). Ни о том как подключать проектор, ни о том что он умеет...ничего!!
 
Цитата
writer пишет:
Вчера купил проектор и обнаружил там самую потрясающую инструкцию, которую я видел. Собственно, вот и она:





Больше там ничего не было)). Ни о том как подключать проектор, ни о том что он умеет...ничего!!
Это один из подходов локализации  :D . Зачем нанимать переводчиков, если можно изобразить картинками на всех языках ))

А я когда купил наручные часы Casio, офонарел от мануала: в коробке было 5 маленьких книжечек мелким шрифтом по 500 страниц "сокращенной версии" мануалов на разных языках. И в каждой главе ссылка на "полную" документацию на сайт касио.
Изменено: ADVANCED - 08.12.2014 10:24:05
 
действительно, в плане локализации очень удобно)
Торопливость в выводах может привести к неприятностям
 
Цитата
ADVANCED пишет: А я когда купил наручные часы Casio, офонарел от мануала: в коробке было 5 маленьких книжечек мелким шрифтом по 500 страниц "сокращенной версии" .
тоже неплохо, но зачем? Часы еще , наверное, механические?))
 
Цитата
writer пишет:
Цитата
ADVANCED пишет: А я когда купил наручные часы Casio, офонарел от мануала: в коробке было 5 маленьких книжечек мелким шрифтом по 500 страниц "сокращенной версии" .
тоже неплохо, но зачем? Часы еще , наверное, механические?))
Нет, не механические  :)
 
 
Изменено: Andreyka - 27.07.2015 17:05:42
Страницы: 1 2 След.
Читают тему