Какую систему выбрать для документирования и описания структуры и дизайна сайта?

Question

[Антон Р.]

В общем есть один проект который разросся до такой степени что начинается путаница в правках и общей структуре. Если ли какие то системы которые позволят понятно и логично описать следующие моменты:
1. Общая структура сайта
2. Дизайн каждой страницы

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

Какие есть сервисы для этого?
Сейчас всё делается через Гугл Документы, это не удобно :(

Answer 1

[VoidVolker]

XWiki, DokuWiki, GitLabWiki, GitHubWiki и любая другая вики. Главное — интеграция с вашим трекером задач, а так же вашим гит-сервером. Дабы была возможность везде легко использовать короткие ссылки на задачи, страницы, запросы на слияние в гите и прочее. Остальное — ставьте, щупайте, подбирайте то, что вам больше подходит и нравится.

Comments

[Антон Р.]

Яндекс Вики насколько надёжная штука? Нужна именно облачная.

[VoidVolker]

Антон Р., с учётом репутации данной компании — про надёжность можете забыть.

[Антон Р.]

VoidVolker, что не так с репутацией? Я имею в виду что насколько надежно там иметь базу знаний.

[VoidVolker]

Антон Р., ну, например, оплачиваешь такси или еду картой, а тебе потом в рандомный момент на все использованные карты незаконно подключается подписка и начинается списание денег? И несколько вечеров борьбы с ТП за отмену? Наплевательское и потребительское отношение к клиентам компании, лишь бы денег снять? Приложения со встроенным шпионским ПО и обозванное "технический сбой/случайность" представителями компании? А если поискать в сети — ещё кучу всего другого найдёте. Вы готовы доверить такой компании хоть что-то важное? Лично я — не готов. Сегодня, увы, приходится все важные сервисы размещать на своих серверах. Чего и вам советую. В большинсте трекерах задач и гит-серверах есть встроенные вики. Чем они вас не устраивают? Какой таск-трекер? Гит?

Answer 2

[GavriKos]

Confluence и тому подобные вики-системы.

Comments

[Антон Р.]

Confluence не подходит:

[Василий Банников]

Антон Р., любая другая вики-система.
А дизайн в фигме

Answer 3

[Александр Нестеров]

Как вариант - obsidian. Это очень мощный редактор заметок. В подробностях описывать не буду - функций в нем реально очень много. Но из ключевого - активные ссылки на другие документы, чек-листы, подсветка кода, шаблоны страниц.

Вот для примера, cписок todo в моем pet-проекте

Документация по коду

Граф всех связей в проекте

К тому-же есть тьма разных плагинов и тем на любую потребность.
Единственный минус - он работает оффлайн. Но если в остальном оно будет вас устраивать - можно положить документацию в git-репрозиторий с самим приложением (ну или в соседний, если не хотите давать доступ)

Comments

[Антон Р.]

Для РФ доступен без бубнов? Конфлюенс например нет.

[Александр Нестеров]

Антон Р., ну да. Он не требует аккаунтов, подписки и прочего - раз скачал установщик и пользуйся сколько угодно

[godsplan]

то что мне не нравится в обсидиане это невозможность шейринга как в том же ноушене. ну либо я не нашел такого

Answer 4

[dmitriy]

miro