Как грамотно запросить документацию на сайт?

Question

[denism300]

Хотим передать сайт на поддержку другой компании, как грамотно запросить всю документацию (грубо говоря, чтобы было понятно какой файл за что отвечает, где описаны те или иные функции и т.п., чтобы новой компании потребовалось как можно меньше времени на вхождение в суть дела)?
Возможно, есть какие-то готовые примеры.

Comments

[sim3x]

Сайт на чем написан?

[denism300]

modx

Answer 1

[Евгений Вольф]

Как грамотно запросить документацию на сайт?

У кого?

modx

Документация на Modx должна быть бы либо на их сайте, либо в районе их их репозитория, например тут и тут. Если же Вы говорите про более глубокую документацию, например по каждому отдельно взятому решению принятому на уровне системы, с учётом того, что это Modx, я думаю, наиболее вероятным вариантом ответа будет - отсутствие (чуть менее чем полное) подобной документации в природе.

Comments

[denism300]

У кого?

у разрабов текущего сайта

не на modx, а на сайт, грубо говоря, чтобы было понимание, какой чанк, сниппет и т.п. за что отвечают, как реализованы те или иные функции.
чтобы новой компании пришлось потратить как можно меньше времени на вникание в реализованный функционал.

[Евгений Вольф]

Как грамотно запросить документацию на сайт?

не на modx, а на сайт, грубо говоря, чтобы было понимание, какой чанк, сниппет и т.п. за что отвечают, как реализованы те или иные функции.

На самом деле, не до конца понятно, как эту самую документацию можно запросить "не грамотно"... но "грамотный запрос" я думаю должен выглядеть примерно, как письмо со следующим содержанием:

Здравствуйте уважаемый Иванов И.И., в соответствии с таким-то пунктом, такого-то договора (или иного документа) прошу Вас предоставить нам документацию в таком-то виде.

Для пущей "надёжности" и "грамотности" подобного запроса можно отправить это письмо в бумажном виде, местной почтой, с уведомлением о вручении, описью вложений и прочими атрибутами, ну и заодно напечатать его (письмо) на фирменном бланке и заверить печатью и подписью руководителя.

[denism300]

Евгений Вольф, вы не поняли. имеется в ввиду, как правильно описать вот это:

чтобы было понимание, какой чанк, сниппет и т.п. за что отвечают, как реализованы те или иные функции.

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

[Евгений Вольф]

denism300, ааа, Вы правы, я не сразу понял, о чем идёт речь. Я думаю, Вам стоит вписать это уточнение в текст вопроса, думаю, многие так же не совсем поняли о чём Вы говорили. Я постараюсь Вам чем-нибудь помочь в данном вопросе несколько позже (по прибытию домой).

[denism300]

Евгений Вольф, ок, спасибо заранее. буду ждать

[Евгений Вольф]

denism300, я думал-думал... и понял. А Вы у конечной фирмы не пробовали уточнить, им самим что нужно, что непонятно? А то мы тут с Вами сидим, рассуждаем... и конторе которая будет поддерживать сайт - может всё понятно без нашей помощи и рассуждений?