powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Описание системы для новых разработчиков.
14 сообщений из 14, страница 1 из 1
Описание системы для новых разработчиков.
    #37790651
Manfred777
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Добрый день коллеги по цеху.
Собственно встала с виду довольно тривиальная задача. На данный момент есть огромное решение >100к строк кода. Команда которая его писала через некоторое время переходит на другой проект. Есть возможность дать этой команде задание создать чтото типа wiki для разработчиков которые придут поддерживать и развивать проект. Есть примеры чего то похожего. Нужно что бы человек который придёт на проект сел читать то что было написано и начинал понимать что и как внутри системы. Написан проект на ASP.net. Есть различные сторонние вещи которые используются их тоже соответственно надо описать как то.

Заранее спасибо. Умные мысли можно выкладывать ниже. С нравоучениям в другое место. =)
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37790660
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Manfred777С нравоучениям в другое место. =)
хорошо что сам выбрал себе направление, начав топик с нравоучений. Свобден
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37791928
й
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Русский язык у автора хромает.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792309
Злой Бобр
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Manfred777,

Мануала для админов и комментариев в коде будет достаточно. Если придут не студенты.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792663
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Manfred777С нравоучениям в другое место. =)
:)
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792715
Фотография @k@DElpher
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Можно посмотреть в сторону ГОСТ Руководтство программиста.
Но Вики+автогенерация документации за счет комментариев было бы не плохо. Но тогда комментарии нужно качественно продумать (я имею ввиду XML комментирование вроде http://developer.alexanderklimov.ru/articles/xmlcomment.php) Тогда документация сама построится (как MSDN)
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792718
Фотография @k@DElpher
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
@k@DElpher,

красивое введение в систему, описание подходов, шаблонных решений в каждом случае, минигайд "как добавить новую функцию в ситему".
Вроде
1) Создать таблиц в базе
2) Вогнать их в Entity Framework
3) По модели EF создать модели представлений
4) Добавить новую страницу
И между строк - наладить безопасность, как добавить форму ввода, как добавить таблицу, как отображать список.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792726
Vladimir Baskakov
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Умные мысли можно выкладывать ниже где бы их взять, умных.... берите что есть....

Manfred777Есть возможность дать этой команде задание создать чтото типа wiki для разработчиков которые придут поддерживать и развивать проект

лучше обеспечить возможность контакта между старой и новой командами. Писать хорошую документацию - понятную и структурированную - это самостоятельный навык, который не всегда в полной мере развит у разработчиков. (я имею в виду кодировщиков). Если не использовались средства класса docutils то сейчас наверное уже немного поздно метаться. Если говорить о том, какие движки вики использовать, то http://ru.wikipedia.org/wiki/DokuWiki кажется мне подходящим выбором - легко развертывать и админить, странички выходят аккуратные....
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792739
Vladimir Baskakov
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
.... не знаю - умная это мысль, или нравоучение или наблюдение - но уходящая проектная команда не всегда сильно мотивирована на документирование.... Как их в этом заинтересовать - я не знаю....
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37792889
Sergey_rb
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
На прошлой работе для документирования нанимали человека на 3 месяца.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37793019
_мод
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Manfred777Умные мысли можно выкладывать ниже.
1. Руководство пользователя (описание назначения и функций системы)
2. Описание БД (очевидно)
3. Описание программ (структура, модули, функции, связи, исходники)
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37793209
Alexsalog
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Я не могу дать совет как человек создавший или видевший правильные примеры описаний, зато я был в роли сопровождавшего и в последствие изменявшего чужой код. Тоже кстати на ASP.

Для меня самым главным для понимания работы системы явились несколько вещей:

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

после этого переходим к пункту 2 -
2) Понимание порядка, последовательности и логики изменения данных в таблицах в отражении на порядок работы.

3) Описание процедур ответственных за изменение и обработку данных. Описания должны даваться по каждому этапу описанному в пункте 1). По каждой процедуре желательно описание принципа работы в зависимости от её сложности.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37794359
LSV
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Sergey_rbНа прошлой работе для документирования нанимали человека на 3 месяца.+500
Качественное документирование по стоимости сопоставимо со стоимостью разработки.
Как правило это неподъёмная цена. Ну нет желания "на ровном месте" поднимать стоимость продукта вдвое. :)
Сделают документирование для отвода глаз. Полегчает ?

Тем не менее заставить написать пару страниц жизненно важной инфы все таки следует.
А также обязать отвечать на вопросы, кот. возникнут в процессе ознакомления с продуктом новой команды.
...
Рейтинг: 0 / 0
Описание системы для новых разработчиков.
    #37795669
neoddd
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
[quot LSV]Sergey_rb...
Сделают документирование для отвода глаз. Полегчает ?

Тем не менее заставить написать пару страниц жизненно важной инфы все таки следует.
А также обязать отвечать на вопросы, кот. возникнут в процессе ознакомления с продуктом новой команды.

Все к этому и придет. Ибо, как говорил какой-то известный предприниматель : "я знаю, что трачу 50% рекламных денег зря. Не знаю только, которые это 50%"

Я думаю с документацией это легко могут быть 80-90%, которые вы не знаете что зря. А вот как узнать, которые 10-20% действительно нужны?
...
Рейтинг: 0 / 0
14 сообщений из 14, страница 1 из 1
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Описание системы для новых разработчиков.
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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