Тендер на создание пользовательской документации

Блог разработки LiveStreet

Решили объявить тендер на написание пользовательской документации по LiveStreet.
Причина — банальная нехватка собственного времени. Поэтому надеемся, что среди активных пользователей нашего сообщества найдется(найдутся?) тот, кто сможет нам в этом помочь. Не бесплатно.
Мы готовы на это выделить 5000 рублей.

Что требуется: написать так называемый user guide в формате HTML по использованию LiveStreet для «чайника», желательно с иллюстрирующими скриншотами. Т.е. структурировано, доступным языком написать как пользоваться LS начиная от установки и настройки конфига, до создания своего блога/топика, голосования и т.п.

Есть желающие?

P.S. В итоге хочется получить что то подобное — liverpoolwebdesigner.files.wordpress.com/2008/01/wordpress_user_guide_v2_beta.pdf

UPD Кандидаты могут предложить структурированное оглавление руководства, это будет также критерием при выборе исполнителя.

46 комментариев

avatar
вобщем-то если только «простого смертного» (т.е. как устаовить, настроить без премудростей программирования), то почему бы и нет..)
avatar
Написал кусочек, посмотреть и оценить можно тут.

З.ы. Для чего нужен тег? :)
<video></video>
avatar
только изображения в png сохраняйте ;)
avatar
не, это скорее мне пора перестать пользоваться суровым пэйндом :)))
Обязательно учту.
avatar
а у меня пейнт умеет в пнг сохранять
avatar
Все отлично, но вы пишите буд-то кроме MS Windows с Денвером никаких других систем не существует.
avatar
Существуют. В ТЗ написано, что нужен "гайд по ЛС для самых маленьких в картинках". По сути выбор ОС и сборка сервера вообще не должны входить в содержание, но были включены в силу предотвращения вопросов типа:
«я скачал архив, распаковывал в папку, запускаю, не работает. В чем проблема?».
Как ни странно винда самая популярная ОС среди тех, кто при установке не может обойтись файлиом Readme.txt. Чтобы установить денвер нужно нажать 2 кнопки, по которым в интернете уже написано очень и очень много букв.
avatar
video нужен для вставки видео-роликов из youtube/rutube (в стандартной инсталляции) по адресу ролика
<video>http://www.youtube.com/watch?v=_AlVK4UjRv8</video>
avatar
Есло можно напиши конктернее, что должно входить в гайд. Ато 5000 рейблей, как-то многовато для простого гайда :)
avatar
добавил в топик пример гайда для WP
avatar
А в какой срок нужно выполнить работу? Я просто собирался досовершенствовать свой ФАК, так что с удовольствием прийму участие.
avatar
2-3 недели
avatar
Я бы взялся, но что именно нужно? навигация по сайту, работа с шаблонами, ну или программная часть? И что если будет 2-3 документации, кому вы заплатите?
avatar
Всё о чем должен знать пользователь/администратор LS, исключая верстку и кодинг. Дополнительно основные моменты, например, как добавить нового администратора и т.п. Т.е. прочитав гайд пользователь должен разобраться какие возможности дает LS, как ими пользоваться, как их настраивать, как протекают те или иные процессы, например, принцип вывода на главную, принцип ТОПа и т.п.
И что если будет 2-3 документации, кому вы заплатите?
вообще выбор исполнителя будет ДО результата. Также вы можете объединиться, сделать различные разделы и поделить сумму.
avatar
ИМХО сначала нужно сделать призентабельный вид www.livestreet.ru (более качестнный и красивый шаблон, на уровне, так сказать, некое подобие международной версии которую показывал нам ORT ) чтобы документация была намного интересней и красивей(с красивыми картинками внутри и неменее «красивым» руководством)

p.s движок двигается в гору, пишутся плагины, хаки, а шаблон не меняется.
avatar
Надо признать, что дефолтный шаблон мегаудачный.
avatar
речь идёт не о шаблоне который идёт вместе с движком, а о дизайне самого сайта.
Моё мнение что надо менять сам сайт, сделать форум, основной сайт это будет новости кмс, модули, и тд. А так народ пишет свои вопросы в свой персональный блог, который никто не видит
avatar
все верно (шаблон new пусть остается как основной шаблон после установки движка, он, как вы сказали мегаудачный) а самому сайту нужно сделать более призентабельный вид, мое мнение на этот весь счет нужно просто структуризировать это все дело, чтобы люди не в свой блог писали проблемы, а предположим в блог «техподдержка»(отдельный блог где пользователи задают вопросы а другие отвечают на них), о новых модулях, в блог «пользовательские модули»(допустим)

и все это дело обернуть в очень красивую упаковочку вместе с отдельной ссылочкой «документация» :)
avatar
Вы о чем вообще говорите? Речь идет о документации к движку, а не сайту. Такую документацию можно будет использовать на сайтах под ливстритом в качестве хелпа, конечно без разделов по установке и конфигу. И так как дизайн многие делают свой, то и иллюстрации в такой хелп подставят свои.
avatar
презентабельный вид будет на другом сайте, а этот будет сообществом LS, построенным на базе LS
чтобы документация была намного интересней и красивей
текущий внешний вид «приелся» исключительно бывалым старичкам, а документация рассчитана в основном на новичков
avatar
если сделать удобную навигацию, то и вопросов особых не будет, но для этого надо сделать полную админку, а пока её нет это не двиг для новичков
avatar
как соотносится «удобную навигацию» и «надо сделать полную админку»?
avatar
Смотрите, фреймворк очень гибкий, и редактировать код обычному пользователю который хочет сделать на ЛС сайт не надо, всё что необходимо сделать юзеру для создания сайта это: скачать двиг, установить, поставить шаб, поставить нужные модули. То есть вопросы в основном могут возникнуть только по настройке, из-за этого хорошая админка просто необходима, но допустим вопрос у пользователя возник, что он сделает? Он создаст новый топик, потому что хотя б найти нужный раздел где искать похожую проблему он не найдёт, а поиск не всегда поможет (не каждый сформулирует правильный запрос). А вот почему я говорил про форум, а не ЛС, потому что много флуда, барак на сайте. На форуме легче.
комментарий был удален
avatar
Хабра-парадигма LS не подходит для представления структурированной информации. В итоге вроде что-то по движку в недрах LS наверное есть, но реально найти это нереально. Поэтому для документации надо что-то другое придумывать, хотя бы wiki поставить.
avatar
вики пройденый этап. уже ставили, однако никто не писал в нее.
avatar
Не писали из-за больших требований к автору. Имеется ввиду рейтинг =)
avatar
Дефолтный шаблон — LS технически наверное безукоризнен, но зачем было брать его за основу непонятно… наверное чтобы дать возможность разработчикам шаблонов заработать. Прошу простить что не по теме, но серость она и есть серость.
avatar
Дефолтный шаблон — LS технически наверное безукоризнен, но зачем было брать его за основу непонятно…
Вы дефис туда поставили? А то я не пойму… Его это шаб или его это сам двиг
avatar
вот это номер :))) Макс, ты хоть понимаешь, что ты сейчас делаешь? :))) Хорошее начало конца…
комментарий был удален
avatar
Извините, я здесь новенький, но этот сайт и является основным «факом»…
Все остальное — лишнее…

P.S. Когда появляется руководство, интерес пропадает....(Кто читает руководства?)
avatar
Я читаю!
avatar
для таких популярного проекта руководство необходимо, кому надо тот прочтет, а кому надо будет пользоваться поиском по сайту
avatar
Вижу начинается подготовка к открытию нового сайта. Доки это хорошо, ближайший пример — DLE. CHM файл, все структурировано, довольно наглядно и понятно, даже без скриншотов. Но скажем так — dle движек очень просто по установке и настройке, проще чем ls, не намного, но все же проще.

Проблема CHM файлов — это их локальность. Wiki — отличное решение, надо лишь придумать хорошую мотивацию для заполнения, от простых ссылок на свои сайты, которые можно указывать в качестве демонстрации либо примера в дополнению к статье, до буквально копирайтерского вознаграждения — плата за кол-во символов.
avatar
CHM файл, все структурировано, довольно наглядно и понятно, даже без скриншото
Чесно говоря за 3 года работы с DLE, только что открыл справку, и не скажу что она такая идеальна: установка, настройка, работа с шаблонами.

Dle нельзя сравнивать с LS, не знаю как для остальных, но для меня LS это фреймворк. Но LS никогда не раскрутится до DLE, но не потому что он хуже(LS в разы лучше), а потому что людей которые хотят создать сайт но ничего не умеют больше чем тех кто разбирается в этом. DLe — лёгк в использовании, удобная админка, да и хорошо подходит для порталов. LS — требует немного покрутится, да и социальная сеть не так востребована и популярна как порталы.
avatar
а куда заявки подавать?
  • tih
  • 0
  • ↓
avatar
в этот топик, либо любым другим способом (личка, мыло, icq)
avatar
Хорошее начинание. Поддерживаю.
avatar
Готова помочь бесплатно. Русским языком владею, ливстрит люблю, так что если не будет хватать времени на какие-то разделы — я с удовольствием их напишу.
avatar
есть предложение!

если тов. deputydeath согласен, то предлагаю взять его мануал за основу. положить его в коллективный svn/git/(ещё что-то) и коллективно написать, ведь задача весьма объемная и одного человека мало, хотя бы с той точки зрения, что для оценки воспринимаемости текста надо много читателей.

после чего оценить объем вклада каждого соучастника сего действа и поделить 5к по-братски :)
avatar
Считаю, что стоит отделить руководство пользователя от других руководств (по установке, по администрированию и.т.д.). В общем предлагаю сделать отдельно инструкцию для пользователей и отдельную для администраторов.

Содержание пользовательской документации представляю себе пошаговым, вот, примерно, таким:

1. Войди в «название ресурса»
1.1 «Выбери имя и пароль или войди по OpenID» — описание процедуры регистрации или входа по OpenID
1.2 «Наполни свою страничку» — пример заполнения профиля

2. Начни общаться
2.1 «Комментируй» — описание процедуры комментирования, особенности размещения комментариев на странице, описание системы голосования за комментарии и ее влияния на силу/рейтинг, описание блока «Прямой эфир — комментарии»
2.2 «Публикуй посты» — описание процедуры публикации поста, описание возможностей редактора с примерами, отличие персональных от коллективных, условия необходимые для попадания поста на главную.
2.3 «Создавай блоги»
2.4 «Пиши сообщения» — описание процедуры отправки сообщений и коллективной переписки
2.5 «Заводи новых друзей» — описание процедуры добавления друзей

По идее нужен шаблон, который можно будет редактировать под целевую аудиторию каждого отдельного ресурса на LS.
avatar
тема заглохла
давайте коллективно малевать
trac.lsdev.ru/livestreet/wiki/UserManual
avatar
поехали…
avatar
Немного допилил. Хорошее начало, буду постепенно дополнять.
avatar
Я бы поучаствовал в написании манула по движку для программистов. по моему это куда интересней и важнее.
Только зарегистрированные и авторизованные пользователи могут оставлять комментарии.