|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Добрый день/вечер/ночь/утро :) Подскажите, please, примеры документирования небольшого проекта. Часть системы кадрового учета, а именно - табельный учет. Руководство требует написать такую доку, с помощью которой, при уходе ключевых разработчиков ( в отпуск или совсем :-) ), остальные, зная общие принципы работы подсистемы, смогли в приемлимые сроки (а они определены в 2-4 дня) разобраться в любой функции проекта. Т.е изменит алгоритм какого-нибудь use-case-а, к примеру, расширить функциональность, при этом ничего не поломав. Или, еще пример, перетащить всю систему на другой сервак ну и т.п. Пока у меня сложилось следующее: 1. Краткое описание проекта - для чего, для кого, какие функции он несет. 2. Описание взаимосвязей с другими подсистемами и смежными системами. 3. Схема БД с пояснениями. 4. Диаграмма классов (из RUP). 5. Диаграмма активности (из RUP). 6. Основные алгоритмы (блок-схемы или диаграммы активности?). 7. Руководство пользователя. 8. Руководство админа (админа именно подсистемы, т.е настройка справочников, раздача прав доступа внутри подсистемы и т.п.). 9. Руководство сисадмина (или DBA?) - как устанавливать и настраивать. Спасибо. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 10:33 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Что, никто доки к проекту не делал? Ну please! ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 11:19 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Артем1 Так ведь в первом постинге сам себе и ответил на вопрос, но сюда еще надо добавить хранения всех исходников на одной машине, там же и должен собираться проект. Хотя если руководство может допустить уход всех ключевых разработчиков, то оно заслуживает получение проблем в полном объеме. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 15:28 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2AISOFT Насчет руководства - это само собой. Все уже ушедшие разработчики все бросили как есть. Это конечно прикольно было-бы, если бы не мне все это г$ досталось. :) Исходники, понятное дело, хранятся на одной машине (сервер разработчиков) в системе контроля версий. Просто доки в полном объеме первый раз делаем, поэтому опыта ну никакого. Больше чем HELP никогда не писали. Хочется поболее информации, кто как делал и т.п. ИМХО, потом самому-же пригодится. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 15:47 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Вопрос актуальный. Будем ждать содержательных ответов. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 15:56 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Э-х-х будем ( В понедельник :) ) ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 16:02 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Будем ждать содержательных ответов. Конкретный ответ - конкретный вопрос. Иначе придется книги переписывать. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.03.2003, 16:10 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 Артем1: Руководство требует написать такую доку, с помощью которой, при уходе ключевых разработчиков ( в отпуск или совсем :-) ), остальные, зная общие принципы работы подсистемы, смогли в приемлимые сроки (а они определены в 2-4 дня) разобраться в любой функции проекта. Слишком общие требования к описанию системы даже если ориентироваться на RUP (редуцированный), к-рый стандарт де-факто. Кроме того это может отнять много времени и оказаться потом ненужным т.к правильно все-таки когда документация возникает не после, а при создании системы. Далее: ваше руководство должно выставить и подписать требования к системной документации , четко понимая что оно хочет и зачем и сколько ему это будет стоить Т.е изменит алгоритм какого-нибудь use-case-а, к примеру, расширить функциональность, при этом ничего не поломав. Или, еще пример, перетащить всю систему на другой сервак ну и т.п. Можно вообще обойтись без UC (к тому же многие в России используют их только для общего описания,а модель анализа и проектирования берутся "из пальца"), а скажем использовать полное ТЗ или ТП на систему, где подробно расписана ее функциональность. Тогда будут нужны только модель классов и данных 1. Краткое описание проекта - для чего, для кого, какие функции он несет. 2. Описание взаимосвязей с другими подсистемами и смежными системами. Де-факто и де-юре (ГОСТ 34.602) это не отдельный документ, а часть ТЗ 3. Схема БД с пояснениями. Как раз это должно появиться либо (а) из отдельного ТЗ на БД, либо (б) из модели UC-анализа 4. Диаграмма классов (из RUP). 5. Диаграмма активности (из RUP). Вообще-то сначала появляется модель UC , а затем модель анализа , частью к-рой и являются активности, а только затем модель проектирования , частью к-рой является модель классов 7. Руководство пользователя. 8. Руководство админа (админа именно подсистемы, т.е настройка справочников, раздача прав доступа внутри подсистемы и т.п.). 9. Руководство сисадмина (или DBA?) - как устанавливать и настраивать. Это все - руководство пользователя, где пользователи это: основные пользователи(кадровики, бухгалтера, директора и тд) и администраторы ... |
|||
:
Нравится:
Не нравится:
|
|||
15.03.2003, 00:06 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 Репликант Большое спасибо за комментарии. ... |
|||
:
Нравится:
Не нравится:
|
|||
17.03.2003, 08:20 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Человек спросил, где можно посмотреть пример того, как грамотно документируется небольшой проект. Думаю, что вопрос задан вполне ясно и конкретно. Из того, что никаких адресов, где можно просмотреть проект и документацию на него, никто не написал, я делаю вывод о том, что никто из тех, кто прочитал этот вопрос, свои проекты не документирует. ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 14:27 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 wara: Неправильный вывод. Никто не документирует правильно . Либо проекты у всех большие :). У нас, теоритически, документация должна включать как минимум ТЗ и схему БД (в ERwin), далее возможны какие-то доп. документы. Диаграмма классов для прил. клиент-сервер, на мой взгляд, не всегда нужна - у нас бизнес-логика сосредоточена на сервере. К сожалению, чаще всего там где документация особенно нужна, ее нет. ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 15:24 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Последовал советам Репликант-а. Кому нить интересно, какие требования выставило и подписало руководство? ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 16:29 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Ну да. И интересен будет результат. Если это не коммерческая тайна конечно. ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 16:39 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Не, не коммерческая. Код: plaintext 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. 30. 31. 32. 33. 34. 35. 36. 37. 38. 39. 40. 41. 42. 43. 44. 45. 46. 47. 48. 49. 50. 51. 52. 53. 54. 55. 56. 57.
Из наработок в течении хода проекта только прецеденты, схемы (физ. и лог.) из ErWin, диаграммы классов и взаимодействия из RationalRose). Пока сделаны только логическая и физическая схемы БД (в смысле описание к ним). Хотелось бы знать мнение уважаемых членов форума по поводу этого произведения. Заранее извиняюсь, если будут какие вопросы, то ответы только завтра, т.к. рабочий день кончился ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 16:57 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
я тут для вас ссылочку откопал - по моему - именно то, что Вам надо. Какой-то проект с документацией. http://www.dbcreator.com/ru/dedal.php ... |
|||
:
Нравится:
Не нравится:
|
|||
19.03.2003, 18:02 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 wara: Человек спросил, где можно посмотреть пример того, как грамотно документируется небольшой проект. Думаю, что вопрос задан вполне ясно и конкретно. Из того, что никаких адресов, где можно просмотреть проект и документацию на него, никто не написал, я делаю вывод о том, что никто из тех, кто прочитал этот вопрос, свои проекты не документирует . Я бы так выразился, что вывод ваш скоропалительный, если не глупый. Нельзя же быть таким наивным по поводу выложенных в нахаляву проектов. А поскольку я сам знаю что ИМЕННО ТАКИХ примеров "от и до" просто нет в Рунете тем более, есть просто статьи, к-рые рассказывают как надо документировать или вести проект в соответствии с той или иной методологией с примерами диаграмм вроде RUP v.2002 Manual, есть опять же какие-то статьи или выложенные работы вроде моделей BP-,DFD-,UC-,данных-,классов для какой-то предметной или системной проблемы и тд, к-рых может несколько десятков, но все это примеры частей , а не проекта целиком. Так что вы предлагаете завалить человека бессмысленными ссылками (вроде вашей http://www.dbcreator.com/ru/dedal.php) чтобы он целыми их бессмысленно лопатил или чтобы он попросил выслать ему пример проекта как это делают в форумах? Да иногда присылают, но как правило с грубейшими методологическими ошибками и это еще больше запутывает поскольку люди начинают тупо копировать под чей-то "правильный" шаблон, не осознавая что и зачем они это делают 2 Артем1: Состав документации на блок «Табельный учет-2» Да, но опять же это иммено состав или перечень, но не требования , к-рым должна удовлетворять документация и для чего она предназначается. Если не секрет, то этот список откуда взялся, уж не начальство ли его выдало на-гора? :) Название документа Пояснительная записка к техническому проекту Включает... Слишком содержательно для одной записки. Очень очень напоминает ТЗ согласно ГОСТ34.602. Вы не спутали название? Название документа Общее описание Включает... .....Список прецедентов Описание каждого прецедента Блок схемы и алгоритмы..... Слишком детально для общего описания. Очень напоминает ТП или минимум ЭП. Опять не спутали названия? Но ход мыслей правильный только можно разбить все на отдельные документы просто для удобства работы с документами и добавить сюда: а) модель пользовательского интерфейса(GUI), б) модель проектирования(классы-данные,взаимодействия и тд.) Из наработок в течении хода проекта только прецеденты, схемы (физ. и лог.) из ErWin, диаграммы классов и взаимодействия из RationalRose). Пока сделаны только логическая и физическая схемы БД (в смысле описание к ним). Опять вопрос: откуда взялась модель классов-данных? Если честно из ВИ(прецедентов), то это хорошо, но опять вопрос как одно получено из другого? ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 07:39 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 Репликант . уж не начальство ли его выдало на-гора? :) Именно :) Очень очень напоминает ТЗ согласно ГОСТ34.602. Не спорю. Только не понял: это плохо или хорошо? Слишком детально для общего описания. Очень напоминает ТП или минимум ЭП ... Почему? Разве детальное описание плохо? На отдельные документы все и разбито. Просто документация на проект, как я представляю, выглядит как папка с документами по приведенному списку. К примеру, список прецедентов и их краткие описания в одном файле (документе) а подробные спецификации каждого в отдельных (м.б. даже в приложении). а) модель пользовательского интерфейса(GUI Что это за зверь? В чем ее полезность? Если можно, поподробнее. Буду очень признателен. б) модель проектирования(классы-данные,взаимодействия и тд.) Это вроде как есть в руководстве программиста. Или Вы считаете, что необходимо вынести в общее описание? Или я Вас не понял? Опять вопрос: откуда взялась модель классов-данных? У нас модель классов данных начала появлятся из требований к новым источникам и хранилищам информации. Спасибо за участие в обсуждении. 2 wara . Спасибо за ссылку. Сейчас вряд-ли уже удастся сильно изменить состав документации, так как над ней уже ведется работа. Но для себя обязательно изучу. Может и почерпну что полезное :). ЗЫ: 2 All Предлагаю к обсуждению. Код: plaintext 1. 2. 3. 4. 5.
... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 08:48 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Репликант, 1. Я совершенно не имел ввиду, что читатели этого вопроса тут же должны выслать автору вопроса полную документацию на свою программу. Насчет того, что никто не документирует, это я конечно, передернул. Но судя по ответам, по моему мнению, авторы этих ответов имеют о предмете вопроса достаточно смутное представление. Любой человек, изучивший какой-то вопрос в достаточной степени, может коротко и лаконично изложить его в сжатом виде. После прочтения ответов у меня не создалось впечатления, что кто-то из ответивших в заданном вопросе хорошо разбирается. 2. Даже кривая и неполная информация - лучше чем ее полное отсутствие. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 11:05 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 wara По пункту 2 - полностью согласен и поддерживаю. Как насчет предложенного к обсуждению вопроса? ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 11:30 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Артем, К сожалению, мне пока нечего сказать по поводу предложенного Вами вопроса. Какими качествами должен отличаться руководитель проекта? Я думаю, что лучше всего на этот вопрос Вам бы ответил человек, который на протяжении жизни плотно работал с многими руководителями проектов (как успешных, так и нет). У меня такого опыта нет, а бессмысленно барабанить по клавишам я не хочу. Кстати, ссылка, котрую я дал, ведет к реальной конторе, где делают реальные проекты (системы автоматического управления для газовой промышленности). Вот у тех людей и надо спросить про то, кто, по их мнению,- хороший руководитель проекта. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 11:49 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
А они ответят? :-) В любом случае спасибо. И за ссылку, и за ответы ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 11:56 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Каким должен быть руководитетель проекта - это ты про себя спрашиваеш? Прежде всего у него должен быть опыт успешной реализации подобных проектов. Второе - он должен понимать что его главная задача не написание каких-то программулек, а соотнесение требований заказчика и возможностей разработчиков. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 12:05 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Не, не про себя. Я пока просто программер. Но плох тот солдат, который не хочет стать генералом :) Т.е. успешный опыт - обязательное условие. Так? Какие еще качества? Возраст, образование? Играют они какую-либо роль? ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 12:08 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
Артем1 Я думаю, что ответят. Этот учебный сайт у них в стадии разработки. Значит кто-то за него платит и есть какая-то цель. Поэтому они должны быть склонны к общению. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.03.2003, 14:34 |
|
Нужна помощь по документированию проекта!
|
|||
---|---|---|---|
#18+
2 Артем1: >>Очень очень напоминает ТЗ согласно ГОСТ34.602. Не спорю. Только не понял: это плохо или хорошо? ПРИМЕЧАНИЕ: Может стоит называть вещи своими именами. Просто есть все-таки какие-никакие стандарты там ГОСТ,ИСО и потом в России есть традиционные уже документы, название, назначение и суть к-рых большинстом разработчиков понимаются и одобряются. Хотя конечно можно изобретать свои правила именования документов :) >>Слишком детально для общего описания. Очень напоминает ТП или минимум ЭП ... Почему? Разве детальное описание плохо? Нет, не плохо - см. ПРИМЕЧАНИЕ выше На отдельные документы все и разбито. Просто документация на проект, как я представляю, выглядит как папка с документами по приведенному списку. К примеру, список прецедентов и их краткие описания в одном файле (документе) а подробные спецификации каждого в отдельных (м.б. даже в приложении). Не обязательно, это может быть одна большая центральная БД/хранилище - репозиторий проекта, в к-ром - все, кончая кодом и т.д Опять же, если планируется RUP, то лучше следовать процессу и брать софт, цивилизованный и заточеннный под процесс, например, Rational Suite (лучше всего - т.к. стандарт де-факто), TogetherSoft, AllFusion или еще что-то, не только ориентированное на UML, но при этом позволяющее осуществлять процесс разработки цивилизованно. Ну, напр, по поводу списка ВИ/прецедентов и требований, то если Rational - это проект RequisitePro, содержащий функциональные требования и их описания, связанные с древом имен ВИ и их описаниями к-рые потом можно передать в Rose или в SODA(чтобы получить по шаблону отчет илилюбой документ, содержащий все это) Так что нет смысла возиться с разрозненными документами и руками перетаскивать из них информацию >>а) модель пользовательского интерфейса(GUI Что это за зверь? В чем ее полезность? Если можно, поподробнее. Буду очень признателен. Проще говоря это "картинки" всего GUI системы(или самой важной его части) с описаниями в контексте функциональной или модели ВИ. То, что обычно программисты рисуют на бумаге или в редакторе ресурсов-форм(Delphi,VB). С этой моделью работает заказчик (точнее верифицирует) и те, кто реализует пользовательский интерфейс >>б) модель проектирования(классы-данные,взаимодействия и тд.) Это вроде как есть в руководстве программиста. Или Вы считаете, что необходимо вынести в общее описание? Или я Вас не понял? См. ПРИМЕЧАНИЕ выше Опять вопрос: откуда взялась модель классов-данных? >>У нас модель классов данных начала появлятся из требований к новым источникам и хранилищам информации. Если с данными я еще соглашусь, то насчет классов берут сомнения в корректности такого подхода. А можно разъяснить, что именно имеется в виду под "требованиями (к новым) источникам ..информации"? Ведь классы не только инкапсулируют данные, но и логику Какими качествами должен обладать руководитель проекта, чтобы он мог из примеров, про которые говорил Репликант, взять только полезное и отбросить цитата "грубые методологические ошибки"?. а) Владеть выбранной методологией или хотя бы быть знакомым с ней, а также процессом. б) Четко понимать, что ему нужно и зачем, исходя из основных требований(технологии,сроки,ресурсы и т.д). Способность к критическому анализу? Это никому не помешает :) Опыт не менее N проектов? Или это неэффективный способ обучения? Возможно, но тогда это должен быть своего рода опыт проб и ошибок с опять же критическим анализом :) Лучше изучать методологию и самому пытаться применять ее на практике? Вобщем, да, если вы разработчик, аналитик и руководитель, т.е. рабочая лошадка, к-рая должна понимать, что за сено она ест. Практический опыт ничем не заменишь и можно прочитать тысячи мануалом, книг, статей, прослушать курсов или посмотреть чужых проектов, но все равно нужно самому "трогать руками" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2 wara: ...Насчет того, что никто не документирует, это я конечно, передернул. Но судя по ответам, по моему мнению, авторы этих ответов имеют о предмете вопроса достаточно смутное представление. Ну а по моему мнению вы тут болтовней занимаетесь, как раз и имея смутное представление о предмете или вообще не имея его. Что-то я не слышал от вас еще ни одного ответа по сути вопроса, ни обоснованной критики чужих ответов Любой человек, изучивший какой-то вопрос в достаточной степени, может коротко и лаконично изложить его в сжатом виде. После прочтения ответов у меня не создалось впечатления, что кто-то из ответивших в заданном вопросе хорошо разбирается. Ну и какой объем информации в байтах, строках, абзацах имеется в виду у вас под словом "коротко" с учетом вашего требования "лаконичности", а также с учетом неизвестных требований к решению вопроса? 2. Даже кривая и неполная информация - лучше чем ее полное отсутствие. Если ее не слишком много и человек в состоянии отсеивать кривой мусор, содержащийся в ней и оценивать степень неполноты этой информации ... |
|||
:
Нравится:
Не нравится:
|
|||
21.03.2003, 08:20 |
|
|
start [/forum/topic.php?fid=32&fpage=175&tid=1546739]: |
0ms |
get settings: |
8ms |
get forum list: |
12ms |
check forum access: |
3ms |
check topic access: |
3ms |
track hit: |
63ms |
get topic data: |
13ms |
get forum data: |
3ms |
get page messages: |
63ms |
get tp. blocked users: |
3ms |
others: | 13ms |
total: | 184ms |
0 / 0 |