Веду небольшой Open Source проект на github. Первоначаьно инстукция помещалась в readme.md. Сейчас нужно уже написать более подробную документацию. Изначально планировал использовать для этого wiki самого github, но редко вижу, что другие проекты ее используют. Есть сервис readthedocs.org. Может быть есть еще какие-то бесплатные сервисы.
Вопрос, где лучше разместить документацию, что бы пользователям было удобнее? Какие есть подводные камни?
Гитхаб позволяет размещать у себя статику: https://pages.github.com
Можно выбрать шаблон и писать MD, можно самому править HTML. Также есть всякие генераторы статики из CMS, можно у себя на компе работать с CMS-кой и забрасывать туда статику.
Можно вот этим ребятам написать https://readme.io, говорят что для опенсорса бесплатно.
Есть еще https://apiary.io если у вас какое то api возможно лучше подойдет.
Простой
Простой
