[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

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


Перевод в процессе
translate in progress

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Инструкция для начинающих, сфокусированные на возможностях программного обеспечения.
  • Инструкция по базовому использованию программного обеспечения.
  • Быстрый старт, использование мыши и горячих клавиш клавиатуры в большинстве повседневных задачах
  • Большие инструкции, описывающие все элементы программы. Включая уроки.
  • Инструкии по админитсрированию. Это те материалы которые вызывают слёзы на глазах большинства пользователей, но этот материал используеться Гиками в первую очередь при решении проблем.
  • Введение и приветствие
    • Что такое Slackware?
    • Чем отличаеться Slackware от Windows и Mac?
    • Что такое Linux?
    • Что такое GNU/Linux?
    • Идея свободного программного обеспечения
  • Руководства по эксплуатации — введение
    • Рабочее окружение KDE
    • Рабочее окружение Xfce
    • Рабочее окружение Fluxbox
    • Базовые техники владения мышью и клавиатурой
    • Базовые сочетания клавиш клавиатуры
    • Использование меню
    • Использование диалоговых окон
    • Поис справки
  • Справочное руководство — Основы работы с компьютером
    • Многозадачность и многопользовательская компьютерная система
    • Безопасность и права пользователей
    • Вход в систему
    • Выход из системы
    • Создание пользовательского аккаунта и групп
    • Правильное выключение
    • Настройка рабочего стола
    • Настройка компьютера для людай с ограниченными возможностями
    • Настройка разных языков
    • Добавление иконок в панель «быстрого запуска»
    • Добавление обьектов в системное меню
    • Описание, что такое папки и файлы
    • Системные файлы и пользовательские файлы
    • Использование файлового менеджера
    • Поиск файлов
    • Использование принтера
    • Настройка системных часов
    • Завершение программ, которые зависли или вылетили
    • Соединенеи с интерентом
    • Посик новых программ
    • Автоматическое обновление программ
    • Вирусы и зловредное программное обеспечение
  • Руководство пользователя — Как я могу …
    • Играть в солитер?
    • Быстро посчитать некоторые числа?
    • Сёрфить в интернете?
    • Просматривать PDF файлы?
    • Отсылать и принимать електронные письма?
    • Организовать списко задач?
    • Написать офиуиальное письмо?
    • Редактировать простой текстовый файл?
    • Создавать заметки?
    • Использовать клавиатурные символы?
    • Создавать напоминания и будильник для себя?
    • Дать детям порисовать?
    • Заняться серьёздным черчением?
    • Исправлять и редактиировать изображения?
    • Чертить бок-схемы?
    • Создать диаграмму?
    • Изучить что либо?
    • Слушать музыкальные файлы?
    • Прослушать аудио компакт диск?
    • Adjust my audio volume?
    • Watch DVD movies?
    • Make backups of my CDs and DVDs?
    • Rip an audio CD?
    • Use my USB flash drive?
    • How do I save camera photographs?
    • Browse and manage my digital photograph collection?
    • Download and read RSS feeds?
    • Chat with my daughter with instant messaging?
    • Edit my web site pages?
    • Manage finances?
    • Manage a small-scale project?
  • Advanced Topics (Appendices or Separate Documents)
    • System Requirements
    • The Command Line Interface
    • Installing Multimedia Codecs
    • Configuring Video Cards and Monitors
    • Configuring Sound Cards
    • Configuring Mice
    • Configuring Internet and Network Connections
    • Configuring Printers
    • Configuring Page Scanners
    • Configuring TV Cards
    • Installing New Software
    • Installing Fonts
    • Installing Firefox Extensions Globally for All Users
    • Creating A Common File Storage Location
    • Scheduling System Tasks and Events
    • Modifying the Bootloader Options
    • Keeping Slackware Secure
    • Updating Security Patches
    • Obtaining Additional Packages
    • Some Thoughts About Backups
  • Administrator's Guide
    • Finding Help
    • Hard Disk Partitioning
    • Installing Slackware
    • Updating Slackware
    • Building Packages
    • Some Unix Basics
    • The Filesystem Hierarchy and Structure
    • Command Line Shell Basics
    • How the Slackware System Boots
    • System Services
    • Kernel Modules and Devices
    • Slackware Package Management
    • Emergency Repair Tricks
    • System Information and Inventory Tricks
    • Solving System Problems
    • Installing Windows in a Virtual Machine
    • Configuring a Firewall
    • Configuring a Router and Family Local Network
    • CPU Frequency Scaling
    • Power Management
    • Managing a Slackware/Windows Dual Boot System
    • Migrating Web Browser Settings
    • Migrating Email Settings

Unsuitable topics

Although a Wiki grants a lot of freedom to its contributors, there are certain topics and subjects best avoided in a Wiki. Some of those may be:

  • Subjective opinions or rants. These style of articles belong to blogs and not to information-sharing Wikis.
  • Topics which are too philosophically oriented. The main Slackware philosophy is already discussed in the Slackware way.
  • Topics which are critical of other distributions or the way other distributions or its maintainers/community approach issues. These kind of topics would show the Slackware community in an unprofessional light. Focus on positives, not negatives.
  • Any topic that is more discussion oriented than information oriented. For example, KDE vs. Xfce, or DE vs. WM. Discussing the preferences for desktop choice is a subjective opinion and not an information article, unless of course, the article has a specific technical input on the subject.

Potential contributors should also check for the existence of a topic in the Wiki before creating a new page with a similar topic. Avoiding duplication of effort is part of what a Wiki is all about.

Sources

  • Originally written by V.Harishankar for the SlackDocs Wiki Project.
  • Additional inputs by kookiemonster based on suggestions made by Woodsman from LinuxQuestions.org forums.

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