[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.

Welcome to the Slackware Documentation Project

Это старая версия документа!


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Инструкция для начинающих, сфокусированные на возможностях программного обеспечения.
  • Инструкция по базовому использованию программного обеспечения.
  • Быстрый старт, использование мыши и горячих клавиш клавиатуры в большинстве повседневных задачах
  • Большие инструкции, описывающие все элементы программы. Включая уроки.
  • Инструкции по администрированию. Это те материалы которые вызывают слёзы на глазах большинства пользователей, но этот материал используется Гиками в первую очередь при решении проблем.
  • Введение и приветствие
    • Что такое Slackware?
    • Чем отличается Slackware от Windows и Mac?
    • Что такое Linux?
    • Что такое GNU/Linux?
    • Идея свободного программного обеспечения
  • Руководства по эксплуатации — введение
    • Рабочее окружение KDE
    • Рабочее окружение Xfce
    • Рабочее окружение Fluxbox
    • Базовые техники владения мышью и клавиатурой
    • Базовые сочетания клавиш клавиатуры
    • Использование меню
    • Использование диалоговых окон
    • Поиск справки
  • Справочное руководство — Основы работы с компьютером
    • Многозадачность и многопользовательская компьютерная система
    • Безопасность и права пользователей
    • Вход в систему
    • Выход из системы
    • Создание пользовательского аккаунта и групп
    • Правильное выключение
    • Настройка рабочего стола
    • Настройка компьютера для людей с ограниченными возможностями
    • Настройка разных языков
    • Добавление иконок в панель «быстрого запуска»
    • Добавление объектов в системное меню
    • Описание, что такое папки и файлы
    • Системные файлы и пользовательские файлы
    • Использование файлового менеджера
    • Поиск файлов
    • Использование принтера
    • Настройка системных часов
    • Завершение программ, которые зависли или вылетели
    • Соединение с интернетом
    • Поиск новых программ
    • Автоматическое обновление программ
    • Вирусы и зловредное программное обеспечение
  • Руководство пользователя — Как я могу …
    • Играть в солитер?
    • Быстро посчитать некоторые числа?
    • Сёрфить в интернете?
    • Просматривать PDF файлы?
    • Отсылать и принимать электронные письма?
    • Организовать список задач?
    • Написать официальное письмо?
    • Редактировать простой текстовый файл?
    • Создавать заметки?
    • Использовать клавиатурные символы?
    • Создавать напоминания и будильник для себя?
    • Дать детям порисовать?
    • Заняться серьёзным черчением?
    • Исправлять и редактировать изображения?
    • Чертить блок-схемы?
    • Создать диаграмму?
    • Изучить что либо?
    • Слушать музыкальные файлы?
    • Прослушать аудио компакт диск?
    • Настроить уровень громкости аудио?
    • Просматривать DVD фильмы?
    • Создать резервную копию моих CD DVD дисков?
    • Сграбить аудио CD?
    • Использовать USB флешку?
    • Сохранить фотографии с камеры?
    • Управление коллекцией фотографий, и их просмотр?
    • Скачивание и чтение RSS новостей?
    • Чатиться с друзьями с помощью быстрых сообщений?
    • Редактировать страницы на моём веб сайте?
    • Управление финансами?
    • Управлять небольшим проектом?
  • Дополнительные темы (Дополнения или отдельные документы)
    • Системные требования
    • Интерфейс командной строки
    • Установка мультимедиа кодеков
    • Настройка видео карт и мониторов
    • Настройка аудио карт
    • Настройка мыши
    • Настройка интернета и сетевых подключений
    • Настройка принтеров
    • Настройка планшетных сканеров
    • Настройка TV тюнеров
    • Установка нового программного обеспечения
    • Установка шрифтов
    • Установка расширений Firefox для всех пользователей (Глобально)
    • Создание хранилища для общих файлов
    • Назначение системных задач и событий
    • Редактирование опций загрузчика
    • Отслеживание уровня безопасности Slackware
    • Обновление и патчи безопасности
    • Получение дополнительных пакетов
    • Некоторые основы резервного копирования
  • Руководства администраторов
    • Поиск помощи
    • Разбиение разделов жёсткого диска
    • Установка Slackware
    • Обновление Skcackware
    • Создание пакетов
    • Основы Unix
    • Иерархия и структура файловой системы
    • Основы командного интерпретатора
    • Как происходит загрузка Slackware
    • Системные сервисы
    • Модули ядра и устройства
    • Менеджер пакетов Slackware
    • Способы восстановления
    • Инвентаризация и информация о системе
    • Решение системных проблем
    • Установка Widnows в виртуальную машину
    • Настройка межсетевого экрана
    • Настройка маршрутизатора и домашней сети
    • Автоматическое изменение частоты ЦП
    • Управление питанием
    • Двойная загрузка Slackware/Widnows
    • Перенос настроек браузера
    • Перенос настроек почты

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

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

  • Субъективное мнение. Этот стиль статей похож на блог, у него нет цели поделиться информацией.
  • Топики сильно философского содержания. Философия Slackware уже обсуждена в Особенности Slackware.
  • Темы которые критикуют другие дистрибутивы, их философию или сообщество/разработчиков. Такие статьи покажут с не профессиональной стороны сообщества Slackware. Сосредоточьтесь на позитиве, не надо негативить.
  • Любые дискуссионные темы к примеру: KDE против Xfce, или оконный менеджер против окружения рабочего стола. Обсуждение преимуществ того или иного варианта, не несут смысловой нагрузки, если конечно не идёт речь о конкретных технических нюансах

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

Схожие темы

Источники

  • Автор оригинала V.Harishankar для проекта SlackDocs Wiki.
  • Дополнил kookiemonster основываясь на предложениях Woodsman с форума LinuxQuestions.org.
  • На русский язык перевёл Oleg A. Deordiev

 ru:slackdocs:contributing ()
Перевод этой страницы?: