Table of Contents

Идеи для вклада в SlackDocs wiki

Вклад в документацию проекта, может оказаться весьма полезным, а так же делом договорённости, многих энтузиастов отпугивает написание документации. Идея вики состоит не в создании идеальной документации, а призыв сообщества к инкрементальному наполнению документации, а так же корректировке ошибок. Следовательно, нет необходимости в долгих размышлениях над правильностью статьи.

Каждый в праве выбирать сам тему для наполнения, чувствуя себя свободно, делясь своими знаниями в вики. Вот области которые могут заинтересовать потенциального вкладчика вики.

Редактируй, Расширяй, Улучшай

Редактировать, расширять и улучшать существующие статьи, это отличный путь для начала вклада в вики документацию. Будучи совместным проектом, любые улучшения и корректировки приветствуются.

Как редактор, вы не должны считать, что редактирование или корректировка менее важна, чем написание собственной статьи. Редактирование, корректировка и улучшение это неотъемлемые части вики, и являются на столько же важными как и написание собственных статей.

Пожалуйста ознакомтесь с Руководство по стилю публикуемых на SlackDocs статей перед тем, как начнёте что либо редактировать.

Основы написания информационного материала

Когда вы достаточно уверены, что прошли стадию редактирования и правок существующих статей, вот некоторые идеи для авторов статей, в порядке не по значимости.

Технические ЧаВо/Уроки

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

Некоторые примеры технических ЧаВо:

и многие другие.

Конкретные программы или приложения

Короткие информационные материалы по конкретным программам или приложениям. Имейте ввиду, что эти топики не должны быть заменой страницам помощи man-pages. Но этот материал должен предоставлять информацию достаточной для пользоватяля, описывать начало работы с конкретными функциями программы.

К примеру это информация по обычным приложениям персонального компьютера и пакетному менеджеру.

Статьи общего назначения

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

Пример статьи общего назначения Философия Slackware.

Примеры тем для описания

Вот список тем основанных на предложении пользователя Woodsman's. Этот список может послужить хорошим примером, тематик для вики.

На вольную тему

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

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

Схожие темы

Источники