Документирование и сопровождение верстки. Чем удобнее?

Рано или поздно в любой команде разработчиков приходит понимание того, что нужно что-то улучшить. Вот и у нас это произошло :)
Описание проблемы: существует определенное число технологов работающих с фронтендом на долгосрочном проекте. Число технологов увеличивается и возникает проблема коммуникации. Одной из проблем является документирование html и css для лучшей навигации и возможности повторного использования.
Использовать инструментарий бэм и сборку пока не представляется возможным по ряду причин ) Но стиль описания css и html близок к oocss, потому нужен механизм документирования блоков с возможностью текстового описания, размещения превью блока и всего кода, который к нему относится. Код проекта (-ов) на bitbucket.org. Пробовали его wiki — не прижилось.

Суть вопроса: а чем вы пользуетесь?
  • Вопрос задан
  • 4648 просмотров
Пригласить эксперта
Ответы на вопрос 3
@egorinsk
Сделать HTML-страницу/сайт в локалке со сниппетами кода (например: кнопки и формы) и пусть все оттуда его копипастят.

Ну или более правильный способ — сделать макросы в шаблонизаторе на все случаи жизни, если ваш шаблонизатор это поддерживает.
Ответ написан
@DenisZ Автор вопроса
Ну раз минус поставили, то прокоментили б уже. Вопрос глупый? Поставлен некорректно? Недостаточно данных?
Ответ написан
Комментировать
@DenisZ Автор вопроса
Ну, если у вас есть какой-то абсолютно одинаковый блок, который встречается в нескольких разных страницах (вроде блока последних постов на Хабре), я бы его вынес в отдельный шаблон и инклудил. Не знаю, позволяет ли это используемая вами технология, если нет, то это очень плохо, придется и дальше страдать копипастом со всеми вытекающими.

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


С этим да, тут понятно. Это выносится в отдельный шаблон, подключается где нужно и конечно код не тянется и не копипастится. Вопрос именно в этапе до интеграции.
Про таблицу с двумя колонками нужно подумать. Просто я думал есть что-то более «промышленное».
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы