Взаимодействие между кодировщиком HTML / Javascript и кодировщиком языка сценариев сервера? - PullRequest
Новая
       17

Взаимодействие между кодировщиком HTML / Javascript и кодировщиком языка сценариев сервера?

1 голос
/ 12 февраля 2010

Я не хочу, чтобы мой PHP-кодер больше писал Javascript.Я хочу отделить кодирование JavaScript и PHP-кодирование.Как мне написать документацию об этом взаимодействии?

Давайте представим действительно простой запрос ajax.На мой взгляд, документация должна содержать блок-схему последовательности.

  1. пользователь нажимает кнопку «редактировать»
  2. пользователю показывается предзагрузчик
  3. ajax-запрос отправляется на URLajax_request / категория / {category_id} /;мы ожидаем ответа в формате json
  4. таймер запущен;если ответ не получен в течение 10 секунд - отобразить предупреждение «Превышено время ожидания соединения, попробуйте обновить страницу и попробуйте еще раз»*
  5. проверьте, если data.success имеет значение false, а затем выведите предупреждение «Что-то идет не так».
  6. поместите data.html в контейнер

Как видите, действительно труднообъяснить этот поток в текстовом формате.Я знаю, что есть UML для описания таких вещей, но у меня нет опыта.Все примеры UML слишком просты, и я не могу понять, как строить более сложные диаграммы.

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

Я действительно ценю любую помощь.Спасибо!

1 Ответ

1 голос
/ 12 февраля 2010

Есть еще диаграммы для вашей проблемы. Вопрос: «Что вы хотите изобразить?»

  • Поток от вашего шага 1. к вашему шагу 8 Вы должны нарисовать диаграммы поведения. Вы можете использовать Вариант использования (диаграмма для представления действий пользователя), Диаграмма активности (представляющая жизнь алгоритма или процесса) или Диаграмма состояний (если вы хотите представить эволюцию конкретного компонента в потоке, например, http запрос). С другой стороны, вы можете использовать диаграмму взаимодействия для представления взаимосвязи между сервером и клиентом.
  • Структура Как правило, вы должны использовать диаграмму классов. Простым способом:
    • класс для клиента;
    • класс для сервера;
    • класс для запроса;
    • бла бла

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

  • UML4WEB Вы можете использовать диаграммы Conallen , который сделал расширение UML для проекта WEB .
...