Перейти к основному содержанию

Что зачем писать

Не в сети
Зарегистрирован: 09/04/2006

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

Дали задание и попросили изложить видение проболемы: что за чем следует писать, чтобы эффективно по времени получилось, что может вызвать задержки при написании того или иного документа.

С разделами, которые должны содержать требуемые документы, с ГОСТАМИ я разобралась, но вот обощенность ГОСТОв на все программные изделия, сбивает с толку, трудно применить их к порталу, приспособить разделы максимально точно, при этом не отойдя от ГОСТа. Это вызывает возникновение проблем с изложением пресловутого "видения".

Может кто-то уже имел подобный опыт. Буду благодарна любым советам по моей проблеме.

Спасибо Кириллу и Мефодию за предоставленные буквы

Не в сети
Зарегистрирован: 09/04/2006
Что зачем писать

Спасибо, большая головная боль постепенно превращается в маленькую Smile

Спасибо Кириллу и Мефодию за предоставленные буквы

Аватар пользователя surgeon
Не в сети
Зарегистрирован: 10/20/2004
Что зачем писать

Цитата:
только вот есть ли целесообразность в машинных кодах портала?

Нет, однозначно. Все остальное - правильно.

Не в сети
Зарегистрирован: 09/04/2006
Что зачем писать

а очередность написания документации?
Я для себя на данный момент это вижу так:
1. "ТЗ" и "описание применения" как следствие из ТЗ
2. Руководства для всех кому требуется
3. Текст программы (когда будет готов) - только вот есть ли целесообразность в машинных кодах портала? А можть заказчик и сам того не понимает
4. "Описание программы" и "ПЗ" ввиду большой схожести
5. "Спецификация" и "Ведомость эксплуатационных документов" в самом конце в силу их "перчислительного" характера не несущего особого понимания сути портала.

Поправьте, плиз, кашу в моих мозгах, ежели что не так

Спасибо Кириллу и Мефодию за предоставленные буквы

Аватар пользователя surgeon
Не в сети
Зарегистрирован: 10/20/2004
Что зачем писать

Цитата:
ГОСТОв на все программные изделия, сбивает с толку, трудно применить их к порталу, приспособить разделы максимально точно, при этом не отойдя от ГОСТа.

Разделы в документы можно добавлять свои, соответствующие специфике портала - ГОСТ это предусмотрено.


(c) Все права защищены. 2016 Форум Тех. Поддержки Author-IT.ru