System Guide and other technical documents
От: slava.4e Россия  
Дата: 04.04.12 13:55
Оценка: 4 (1)
Доброго времени суток!
У меня вот такая проблема: у нас в компании очень не развита методика написания технической документации, и особенно тесно мы с этим столкнулись буквально на днях при написании System Guide'а. Однако, когда я уже сталкивался с подобной проблемой, я читал книгу описывающую как правильно писать Use Cases (Writing Effective Use Cases), и она мне очень помогла. Теперь собственно вопрос — какие подобные книги есть для написания System Guide'ов? Очень хочу в нее ткнуть нашего технического писателя, что бы хоть как то искоренить ситуацию.
Re: System Guide and other technical documents
От: gandjustas Россия http://blog.gandjustas.ru/
Дата: 08.04.12 10:51
Оценка: +3
Здравствуйте, slava.4e, Вы писали:

S4>Доброго времени суток!

S4>У меня вот такая проблема: у нас в компании очень не развита методика написания технической документации, и особенно тесно мы с этим столкнулись буквально на днях при написании System Guide'а. Однако, когда я уже сталкивался с подобной проблемой, я читал книгу описывающую как правильно писать Use Cases (Writing Effective Use Cases), и она мне очень помогла. Теперь собственно вопрос — какие подобные книги есть для написания System Guide'ов? Очень хочу в нее ткнуть нашего технического писателя, что бы хоть как то искоренить ситуацию.

Думаю проблема не в недостатках методик и знаний. Самое главное при написании любого документа определиться для кого он пишется и какие функции должен исполнять. На эти вопросы зачастую ответить не могут вообще.

Я вот читаю название документа "System Guide" и не могу понять кому и зачем он нужен.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.