powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Design Templates
6 сообщений из 6, страница 1 из 1
Design Templates
    #35632541
McLuad
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Всем привет
Предлагаю обсудить в етой ветке темплайты для следуюших типов документов:
1. Use-Case
2. SAD - Software Architecture Document
3. Low Level design document.
4. Project Plan document
сразу оговарюсь, это для работы на иностранного заказчика, в оффшорных проектах
Разработка может идти по какой угодно методологии, RUP, 4+1, etc
Для каждого типа документа определим его структуру, формат представления данных, уровень детализации и что же все-таки в нем писать.

Готов делится рельными примерами документов в private.
...
Рейтинг: 0 / 0
Design Templates
    #35636113
AlexTheRaven
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
McLuadВсем привет
Предлагаю обсудить в етой ветке темплайты для следуюших типов документов:
1. Use-Case
2. SAD - Software Architecture Document
3. Low Level design document.
4. Project Plan document
сразу оговарюсь, это для работы на иностранного заказчика, в оффшорных проектах
Разработка может идти по какой угодно методологии, RUP, 4+1, etc
Для каждого типа документа определим его структуру, формат представления данных, уровень детализации и что же все-таки в нем писать.

Готов делится рельными примерами документов в private.
SRS, Software Requirements Specification, специально забыли? :)

Вопрос - зачем их определять? Google, опыт и здравый смысл Вам в руки. Шаблонов - миллион, но каждый всё равно делает по-своему. Самое простое - берёте RUPовский шаблон, и выкидываете оттуда всю муть, кроме некоторых названий разделов.

И вообще, ходила легенда, что в одной большой и успешной софтверной компании запрещалось пользоваться чем-либо, кроме блокнота (точнее vi - чтобы писать было трудно, и документы были короткими и лаконичными). А презентации - так вообще проводились только маркером и только на доске. Я думаю, это самое правильное решение.

Самое простое - берёте RUPовский шаблон, и выкидываете оттуда всю муть, кроме некоторых названий разделов. И начинаете писать, но только до тех пор, пока есть что написать, или до тех пор, пока в документе не станет 30 страниц.

3. Low Level design document - IMHO пишется на языке программирования :)

4. Project Plan document - это бизнес-план на проект с точностью +-100% по времени и ресурсам, диаграмма Ганта на итерацию продолжительностью от 2 нед. до 2 мес. с точностью +-50%, или просто обман?
...
Рейтинг: 0 / 0
Design Templates
    #35637882
bas
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Ну еще Vision забыли :)

Low Level design document точно надо выкинуть и подумать о целесообразности SAD, если будет SRS.

AlexTheRaven,
Так можно и весь документ выкинуть :) Если человек не понимает, то лучше брать РУПовский шаблон и заполнять ВСЕ, причем во время этого понимать что в каждый раздел нужно писать.

Лучше всего найти в инете хороший пример нужного документа, выложить сюда и народ либо скажет - стоит его брать за основу или нет. Вот к слову отличный пример Vision от самого Карла Вигерса .
...
Рейтинг: 0 / 0
Design Templates
    #35637890
bas
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AlexTheRaven,

Мы видимо с тобой не прониклись названием темы :)
...
Рейтинг: 0 / 0
Design Templates
    #35643788
McLuad
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
AlexTheRaven
SRS, Software Requirements Specification, специально забыли? :)

Хех,
в моем представлении (возможно ушербном) Requirements model это:
I. Functional Requirements
II. Non-Functional Requirements

1. Functional Requirements
Functional requirements depict the functions that the client expects to be able to perform within the solution.
2. Non-Functional Requirements
Non-functional requirements can be broken down into the following 2nd level packages:
 Business requirements;
 User Interface requirements;
 Hardware requirements;
 Software requirements;
 Performance requirements;
 Security requirements.

3. Business requirements
These requirements describe needs of the customer which are not directly linked to any particular functions of the solution but describe a business objective or objectives which must be achieved as a result of the system being developed.

4. User Interface Requirements
User interface requirements described how the customer would expect the solution to interact with the users of the system.

5. Hardware Requirements
Hardware requirements describe the hardware which will be available to be utilised by the application in order to achieve the solution objectives. This type of requirements is very closely related to the performance requirements.

6. Software Requirements
Software Requirements describe the various software needs of the solution such as operating system, browsers to be used, protocols, third party software etc…

7. Performance Requirements
Performance requirements describe the expectations that the customer has in terms of how the solution will perform under specified conditions.

8. Security requirements
Security Requirements defines system access levels and data protection requirements. Desired security expectations should be described at both hardware (net topology, firewalls etc.) and software (checks, constraints, validations etc) levels.

AlexTheRaven
Самое простое - берёте RUPовский шаблон, и выкидываете оттуда всю муть, кроме некоторых названий разделов.

Метод хорош, но для меня не приемлем

AlexTheRaven
И начинаете писать, но только до тех пор, пока есть что написать, или до тех пор, пока в документе не станет 30 страниц.

30 страниц мало , интересует от 150 и выше :-)

AlexTheRaven
Low Level design document - IMHO пишется на языке программирования :)

Вот именно это и интересует в большей степени.
Скажем, при помощи каких методик Вы опишете следушее:
1. At the application level:
• Description of major components or packages of classes
• Which aspects of external packages / libraries that will be re-used

2. At a “package” / directory / namespace level:
• Class hierarchy / patterns
• Class interaction – how the classes co-operate to solve the problem

3. At a class level:
• Class description – including purpose of class
• Main usage scenarios
• Constraints and assumptions

4. At a function level (for all non-trivial functions, so don’t waste time documenting default constructor etc generated by the compiler)
• Function description
• Constraints and assumptions
• Private or Public?


Следует пояснить, я не прошу помощи, просто хотелось взглянуть на подобные документы, сделанные в других проектах.
В замен могу показать свои :-)
...
Рейтинг: 0 / 0
Design Templates
    #35648055
AlexTheRaven
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
McLuadв моем представлении<...>
Представление очень близко к моему и к классическому. Просто этот документ - IMHO всему голова.

McLuadМетод хорош, но для меня не приемлем
Странно, но ладно. Хотя и любопытно, почему?

McLuad
<...>
30 страниц мало , интересует от 150 и выше :-)
По моему опыту, программисты столько не читают, если это не про фишки языка программирования :) . В получаете деньги за решения или за слова :) ?

McLuad
Вот именно это и интересует в большей степени.
Скажем, при помощи каких методик Вы опишете следушее:<...>
Перед тем, как сяду писать - набросаю эскизы на UML с notes. Если надо будет кому-то передать, выгружу в rtf. Можно, конечно, назвать это SAD, но структура - неформальная, читать должно быть интересно, понимать - легко.

Во время написания - ключевые моменты буду документировать в комментариях к коду. Потом, при необходимости, при помощи javadoc (ну или аналога - подобное есть для многих языков) переведу в HTML. Опять же, можно назвать это low-level описанием, но в отрыве от кода это особого смысла не имеет.

McLuad
Следует пояснить, я не прошу помощи, просто хотелось взглянуть на подобные документы, сделанные в других проектах.
В замен могу показать свои :-)
Боюсь, что не смогу участвовать в обмене - слишком много бумажек с угрозами подписал :) .
...
Рейтинг: 0 / 0
6 сообщений из 6, страница 1 из 1
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Design Templates
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]