Надлежащий способ зарегистрировать или схематически изобразить пользовательские модели событий в DOM
Я создал iFonts , чтобы я мог отправить список по электронной почте дизайнеру. Он совместим вплоть до версии 3.0, поэтому вы можете видеть, какие шрифты доступны в разных версиях iOS, и вам не нужно беспокоиться о том, является ли веб-страница точной или полной. Он был протестирован вплоть до iOS 7.
2 ответа
Я никогда не слышал об установленном стандарте документации для интерфейсов веб-приложений.
При этом, поскольку вы определили различные аспекты своего приложения, которые хотите отслеживать, вы можете сохранить эту информацию в блоке документации для каждого обработчика событий и использовать jsdoc toolkit для генерации некоторых встроенные документы.
ИМХО, я думаю, что, поскольку вы уже знаете, что именно хотите задокументировать, вы можете свободно создавать документацию в любом формате, который вам больше всего подходит, даже если он полностью уникален для вашего приложения / организации. 8 часов на stackoverflow без ответов должны означать, что стандартного ответа нет;)
Честно говоря, я любил визуальное моделирование, и когда MS выпустила его для Visio, я был несколько разочарован.
Тем не менее, Visio по-прежнему отличный инструмент, и вы можете использовать его для создания объектные модели компонентов и определение событий, свойств, методов и т. д. Он имеет некоторую встроенную функциональность для дизайна UML и всего остального.
Но я должен сказать, что в конце концов, я обычно заканчиваю блокнотом или MS Word. В зависимости от того, насколько подробным вы хотите быть в своей документации, набор заметок или описания для компонента никогда не будет хорошо вписываться в любой инструмент DOM, но вы можете полужирным шрифтом, табуляцией, списком и курсивом, как сумасшедший, внутри документа Word.
Звучит грустно, но это правда!