Правила ведения Startup Wiki
From Freshle Knowledge base
Принципы и подходы:
- Startup Wiki - качественная база знаний. Каждая публикация проходит модерацию на соответствие разделу, на качество изложения, на отсутствие воды и шаблонов. Мы будем контролировать качество информации, которая здесь публикуется, иначе вся система потеряет смысл.
- Startup Wiki - открытая база знаний. Любой, зарегистрированный или не зарегистрированный у нас пользователь может публиковать информацию в ней.
- Startup Wiki - структурированная база знаний. Каждая статья относится к определенной стадии запуска стартапов и к определенному типу информации.
- Startup Wiki - практическая база знаний. Каждая статья должна иметь практическое применение, а не быть рассуждениями на абстрактную тему.
- Startup Wiki - некоммерческий проект. Данная база никогда не станет платной, в ней не должно быть прямой рекламы чего-либо, в ней не стоит рекламировать свои тренинги и семинары.
- Startup Wiki - целостная и самодостаточная база знаний. Каждая публикация в случае необходимости снабжается ссылками на другую публикацию, создавая взаимосвязанный поток информации.
Требования и пожелания к материалам:
- Мы не публикуем здесь книги. Во-первых, это часто нарушает авторские права, во-вторых, сама вики должна давать ответы. То есть публиковать собственное изложение книги применительно к конкретной ситуации можно, а необходимости в прочтении самой книги возникать не должно.
- Материалы должны быть снабжены ссылками, если упоминание людей, материалов с других сайтов, полезных онлайн сервисов и т.д.
- Форматирование документа должно быть простым и четким. Избегайте использования разных размеров шрифта, цветов и т.д. Для выделения в тексте каких-либо моментов, как правило, достаточно использования нумерованных и маркированных списков, разделов с заголовками, выделения жирным и курсивом. Размеры шрифта имеет смысл менять только для заголовков.
- При использовании специализированного термина, потрудитесь, пожалуйста, сделать публикацию в Глоссарий и сослаться туда. Или сделать ссылку на Википедию. Или дать определение.
- При использовании сокращений, пожалуйста, давайте расшифровку при первом упоминании, либо сделайте публикацию в Глоссарий и сошлитесь туда.
- Хорошим тоном можно считать величину одного абзаца в пределах 15 строк, величину предложения в пределах 3х строк.
- В начале вашей публикации стоит сразу обозначить цель данного материала. На какой вопрос вы отвечаете? Какую проблему решаете? По поводу чего даете разъяснения? Чтобы читающий ваш материал человек мог сразу понять, нужно ему это или нет.
- По факту написания каждого абзаца старайтесь задать себе несколько вопросов: Действительно эта информация полезна? Какие у читателя возникнут вопросы? Правильно ли читатель меня поймет? Это помогает избегать общих мест и делать текст легко и правильно читаемым.
- Если материалы ссылаются на статистику или исследования, то лучше их сначала поместить в раздел Исследования и статистика, а потом сослаться туда. Не приветствуется упоминание статистических данных без отсылки к первоисточнику.
- Если у вас есть возможность, снабжайте документ схемами и рисунками. Это намного повышает качество восприятия материала. Помните, что человек сначала смотрит на заголовок, потом на картинку, а потом только читает текст.
- Делайте заголовки четкими, полными и понятными. Заголовок должен давать четкое представление о содержании публикации. Помните, что по заголовку будут искать ваш материал.
- Перечитайте свой текст после написания. Вспомните, для кого вы его пишете. Взгляните на текст глазами читателя.
- Продумывайте структуру публикации до написания текста. Это придаст вашему изложению стройность. При продумывании структуры идите от общего к частному. Сначала все основное, а потом подробности и дополнения.
- Старайтесь проставлять взаимосвязи с другими публикациями, чтобы читатель мог по ссылкам пойти дальше рассматривать полезные материалы.
На странице Правила редактирования статей вы ознакомитесь с правилами редактирования статей в Startup Wiki.
