нахер из профессии тогда

Да, вроде бы, все рисуют.

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

В этом проблема.

Вообще-то, скорей всего, тебе нужна flow chart. И да, рисуют. Т.ч. поддрежу JB.

https://hsto.org/files/61a/db0/413/61adb04133254d93831c44467485aa94.jpg

http://habrastorage.org/getpro/habr/post_images/393/787/be9/393787be9630418c0...

Удиви его, нарисуй в таком стиле

ЖоБе прав

Я раньше такое видел в советских книжках по алгоритмике и для программирования микрокалькуляторов и даже не знал, что кто-то такие диаграммы сейчас рисует.

Простите, а вы кто по профессии? Может быть повар?

Блочная схема не единственный способ представления алгоритма, но самый распространённый и понятный большинству. Если вы не можете нарисовать блочную схему процесса

нахер из профессии тогда

серьезно, как оно должно выглядеть? Так что ли?

А зачем оно нужно, если уже есть API документация (Apiary)?

мне не нужна документация внутренних алгоритмов.

Мне нужно описывать типовые процессы REST сервиса с точки зрения его пользователя?

Скорей всего так или так.

Hint: Google images → rest flow chart

Ты объяснил пока только ЧТО произошло. Теперь объясни ЗАЧЕМ это нужно (или от тебя скрывают?).

вот это вот

Мне нужно описывать типовые процессы REST сервиса с точки зрения его пользователя

Глянь мой коммент чуть выше с примерами.

я в последний раз рисовал диаграмму в 8-м классе, когда составлял программу по решению квадратных уравнений для программируемого калькулятора.

А зачем оно нужно, если уже есть API документация (Apiary)?

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

«Лучше один раз увидеть, чем сто раз услышать.» ©

Если вы не можете нарисовать блочную схему процесса

Это может сделать любой, например (для этого нужно посмотреть соответствующие стандарты).

Но возникает вопрос: в том случае, если сеньор себе — это я сам, и речь идёт не о дереве (для изображения которого используется Tikz) или топологии (тоже в Tikz), то не является ли наилучшим и исчерпывающим эстетически использование стилистики, предложенной здесь: https://www.ctan.org/pkg/algorithm2e а именно вот здесь: http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf (см. стр. 7).

Чем это плохо для описания процесса? И как объяснить, что в latex сравнительно немного средств для блок-схем?

В конце концов, беру 1-й том Кнута, лежащий под рукой, пролистываю его и не вижу никаких блок-схем (или скажите страницу). Даже это — уже аргумент.

И потом, нельзя особоб похвастаться наличием инструментов, способных так же качественно, как Tikz, изобразить блок-схему (а это сложно в Tikz, если вам нужно быстро сделать множество схем). Я в курсе про yed и dia.

1) Насколько подорбно должна быть диаграмма? 2) Должен ли я описывать конкретные параметры (query и body) для каждого сценария и responses? 3) Есть ли инстурменты, заточенные под создание диаграмм именно для REST сервисов (web - сервисов)? 3) Какое это имеет отношение к WCF и WWF? 4) На каком языке я должен писать пояснения? На языке читающего или на английском?

Все еще вон из профессии?

Все еще вон из профессии?

да

это не то, это внутренняя кухня самого сервиса.

Еще как рисуем. Буквально вчера рисовали. Пока рисовали, нашли несколько логических ошибок в рассуждениях. Так что с пользой.

На то он и твой сеньор. А ты повинуйся, холоп!

так, чтобы было понятно, что происходит

Два чая вашему сеньору. Знаю примеры как еще в советские годы QA работал благодаря блок-схемам.

Я раньше такое видел в советских книжках по алгоритмике и для программирования микрокалькуляторов и даже не знал, что кто-то такие диаграммы сейчас рисует.

А, то есть Кнута и половину современного CS в нормальных университетах ты не видел в глаза? Поддержу JB, увольняйся.

Я раньше такое видел в советских книжках по алгоритмике и для программирования микрокалькуляторов и даже не знал, что кто-то такие диаграммы сейчас рисует.

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

я не то что нарисовать, я даже представить себе такое не могу.

Просвещайся

сеньор поставил мне ультиматум

Быстрый ответ на ультиматум :)

Напомните, пожалуйста, это не данный ли товарищ не так давно критиковал программистов уходящих и приходящих в его контору?

Блочная схема не единственный способ представления алгоритма, но самый распространённый и понятный большинству. Если вы не можете нарисовать блочную схему процесса

Нарисуй по ГОСТу блочную схему функции eval в лиспе. Ага =) Или хотя бы работы виртуальных методов в ООП.

Вообще-то, скорей всего, тебе нужна flow chart.

Это state machine ака «диаграмма состояний». Практически полезная вещь, в отличие от блок-схемы.

причем здесь майнд-мэппинг?

серьезно, как оно должно выглядеть?

емнип, на блочные схемы есть какие-то промышленные стандарты. Там формы блоков, стрелочек и прочего строго регламентированы.

что юзер сервера знал, как пользоваться REST сервисом, не?

Черти по ГОСТ 19.701-90, на ватмане, чернилами, от руки. И никто ничего не скажет.

в теории, никто не смеет тебе запретить это - несоблюдение ГОСТ преследуется по закону =)

Крайне рекомендую tikz

я знаю, как выглядят блок-схемы. Я знаю, как алгоритм описать с помощью них.

я не знаю, как с помощью них документировать блок-схему всего процесса.

мне не нужны инструменты, мне нужно «как»?

Я с инструментом и сам разберусь.

Это такой КУМировскйи робот/чертежник ныне?

мне нужно «как»

Блин, если ты логику составлял, то ты отлично должен знать, "как"!

И вообще, как ты алгоритм-то рисовал? Неужто без блок-схемы, хотя бы примитивной? Ну, если он почти линейный, то понятно — просто можно на бумажечке пунктики нарисовать, а стрелочками редкие переходы обозначить. Но если там дофига ветвлений, лучше уж блок-схему сварганить.

причем здесь майнд-мэппинг?

Для общего разностороннего развития, ибо блок-схемы можно творить всяческими методами.

А для блок-схем (почти по ГОСТу) — свежий (1 June 2015) «православно-отечественный» DRAKON Editor для Windows, Mac and Linux including Java, Processing.org, D, C#, C/C++ (with Qt support), Python, Tcl, Javascript, Lua, Erlang, AutoHotkey and Verilog.

А вот есть готовые примеры?

Я взял крутанские заголовки из этой темы Заготовки блок-схем для tikz по ГОСТу и пытался их запустить с тестовым примером, но не заработало. Есть вариант запустить весь документ с преамбулой? Или хотя бы увидеть PDF с тем, что там вообще получается.

я в последний раз рисовал диаграмму в 8-м классе

И что? За год всё забыл чтоли? Только не говори, что в инсте вам uml-ю не учили.

Я раньше такое видел в советских книжках по алгоритмике и для программирования микрокалькуляторов и даже не знал, что кто-то такие диаграммы сейчас рисует.

facepalm.jpg

man UML же

А зачем оно нужно, если уже есть API документация (Apiary)?

Расскажи как ты будешь документировать

1) Классы, их связи, взаимодействия. Можно конечно без диаграммы, но диаграмма проще и понятнее.

2) Последовательность и время жизни объектов в классе

3) механизм взаимоедействия с пользователем.

Для этого UML идеальное решение. А вы, извиняюсь, нуб.

Дык, в той теме и есть (с заголовком "Готово" — то, что в преамбулу пихать, а дальше еще и пример есть).

В преамбулу пишешь

\usepackage{tikz}
\usetikzlibrary{shapes, arrows, chains, trees}

ЯННП зачем эти блок-схемы нужны, всегда раздражали. Рисовать схему перед писанием кода - всё равно что положить еду в тарелку и ходить вокруг неё, прежде чем садиться есть.

А код - сам по себе схема. И прочитать его всё равно проще, чем эту вермишель из стрелок.

Если чего-то нет у Кнута, то это не значит, что оно ненужно.

Я раньше такое видел в советских книжках по алгоритмике и для программирования микрокалькуляторов и даже не знал, что кто-то такие диаграммы сейчас рисует.

А потом говорят, что HR'ы задают глупые элементарные вопросы. Где были это HR'ы, когда ТСа брали на работу?!

Были заняты задаванием вопросов про камасутру с синтаксисом языка.

Работает, спасибо. Теперь можно делать действительно супер-качественно!