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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Методы структурированного изложения информации.
 
Добрый день,

У меня следующий вопрос к уважаемым техническим писателям. Случайно наткнулся на документ который описывает коммерческий метод для записи и структурирования информации information mapping (http://www.namahn.com/resources/documents/note-IM.pdf). Хотелось бы услышать сталкивался ли кто с данным методом или подобным применительно к русскому языку?? В общем случае меня интересует какой-либо метод преобразования информации из обычного (повествовательного) изложения в структурированный вид. Т.е допустим, что у меня есть какой либо текст который я хочу отправить по e-mail, я применяю метод структурирования и получаю структурированный текст, который проще для понимания и т.д. получателем.  В конце вышеуказанного документа (стр. 6) есть пример что бы хотелось бы добиться. Знает ли кто либо такие методы применимые к русскому языку, литературу по данной тематике и т.д. ??

Спасибо.
 
Цитата
... литературу по данной тематике и т.д. ??

Из последних книг:
Ю.В. Кагарлицкий
"Разработка документации пользователя программного продукта".
Глава 3. "Структура документации пользователя"
Автор  под структурированностью понимает следующее (цитата):

[color=blue:3gtw8d7q]Структурированность - сквозное свойство документации.
Она выражается не только в делении документа на более мелкие части,  каждая из которых имеет заголовок, но и в рациональном размещении разных видов полезной информации,  в представлении  тех или иных сведений в удобной для восприятия форме (маркированного, нумерованного списка, таблицы),  в обособлении сведений,  на которые пользователю рекомендуется обратить внимаие.
Структурированность документации выражается также и в употреблении  похожим образом построенных словосочетаний, фраз,  фрагментов текста  для описания сходных явлений.[/color:3gtw8d7q]

Указанная глава 3 как раз и учит,  как структуировать документацию.
Страницы: 1
Читают тему