Знакома ли вам ситуация, когда запуск проекта переносится только из-за того, что не готова документация к API или чему-то подобному? Может быть, вам приходилось тратить месяц на разработку системы ведения документации с пользователями, правами доступа и мощным редактором? Вы сами работаете над документацией и погрязли в этой рутине? Вы ответили «Да» на все вопросы?
Закончив написание документации для очередного проекта, мы решили, что так больше нельзя и нужно искать свой путь. Так родилась идея сервиса, который бы помогал работать с документацией легко. Решив не затягивать с этим, остались после работы, что бы обсудить все с командой. Через полчаса мозгового штурма на доске не оставалось свободного места. Осознав, что реализовать это в первые несколько лет работы над проектом мы вряд ли успеем, решили выбрать самое необходимое, что смогли бы сделать за два месяца.
Что такое TurnAPI?
TurnAPI — это стартап для стартапов. И если ваш стартап предоставляет RESTful API, то отличную документацию к нему поможет сделать наш стартап!
TurnAPI — это способ коллективно работать над документацией, своевременно ее обновлять, поддерживать несколько версий.
Beta
У нас есть много идей, как сделать работу над документацией удобнее и быстрее. Мы будем рады, если вы поделитесь своими мыслями по этому поводу. Работа над проектом идет полным ходом, но уже сейчас можно попробовать некоторые вкусные фичи.
Фичи
Что уже готово:
— wiki редактор с markdown синтаксисом, для быстрого написания документации
— git и svn интеграция, что бы писать документацию в любимом редакторе или IDE
— rss, чтобы следить за обновлениями документации
— разные версии документации, для разных версий проекта
— ревизии, чтобы откатывать изменения, а не делать бэкапы
Планируется:
— поддержка горячих клавиш в редакторе
— «Split Mode» — новый режим просмотра в редакторе
— сравнение разных ревизий одного документа
— новые темы оформления
подробнее здесь
Русский язык...
На данном этапе не поддерживается. Мы решили делать первую версию на английском языке. Поддержка великого и могучего появится, как только наберется достаточное количество желающих ;)
