Это старая версия документа!
Содержание
Идеи для вклада в SlackDocs wiki
Вклад в документацию проекта, может оказаться весьма полезным, а так же делом договорённости, многих энтузиастов отпугивает написание документации. Идея вики состоит не в создании идеальной документации, а призыв сообщества к инкрементальному наполнению документации, а так же корректировке ошибок. Следовательно, нет необходимости в долгих размышлениях над правильностью статьи.
Каждый в праве выбирать сам тему для наполнения, чувствуя себя свободно, делясь своими знаниями в вики. Вот области которые могут заинтересовать потенциального вкладчика вики.
Редактируй, Расширяй, Улучшай
Редактировать, расширять и улучшать существующие статьи, это отличный путь для начала вклада в вики документацию. Будучи совместным проектом, любые улучшения и корректировки приветствуются.
Как редактор, вы не должны считать, что редактирование или корректировка менее важна, чем написание собственной статьи. Редактирование, корректировка и улучшение это неотъемлемые части вики, и являются на столько же важными как и написание собственных статей.
Основы написания информационного материала
Когда вы достаточно уверены, что прошли стадию редактирования и правок существующих статей, вот некоторые идеи для авторов статей, в порядке не по значимости.
Технические ЧаВо/Уроки
Сообщество Linux очень ценит использование технических справок, уроков и списков часто задаваемых вопросов. В таких статъях сосредоточено особое внимание на конкретной задаче, пошаговых способах решения с иллюстрированными примерами. В примерах обычно указываются предостирежения как далеть нельзя и почему, это очень важно и помогает читателю не совершать глупых ошибок.
Некоторые примеры технических ЧаВо:
- Как настроить беспроводную сеть.
- Как настроить web/FTP/mail сервер.
- Как настроить интерент межсетевой экран для использования на рабочем компьютере.
и многие другие.
Конкретные программы или приложения
Короткие информационные материалы по конкретным программам или приложениям. Имейте ввиду, что эти топики не должны быть заменой страницам помощи man-pages. Но этот материал должен предоставлять информацию достаточной для пользоватяле, для начала работы с конкретными функциями программы.
К примеру это информация по обычным desktop приложениям и пакетному менеджеру.
General articles
These are articles that do not target any specific technical issue but focus instead on larger issues. A general article needs no specific technical know-how to write, but may be expanded later to provide links or short pointers to in-depth sources of knowledge on the same or similar subjects.
An example of a general article is the one on Slackware philosophy.
Subjects to cover
The following list is based on Woodsman's suggestion. It can serve as a good guide to add content to the wiki.
- An introductory guide, focusing on features and highlighting the software. Somewhat a marketing tool but technical in nature.
- A startup guide, focusing on the basics of using the software.
- A quick reference guide, focusing on mouse and keyboard shortcuts as well as the most common tasks.
- A fat user guide, focusing on all elements of using the software. Often includes tutorials.
- An administrator's guide. This is the stuff that makes most people's eyes water but is the first thing a geek grabs when confronted with problems.
- Introduction and Welcome Guide
- What is Slackware?
- How Does Slackware Differ From Windows and Macs?
- What is Linux?
- What is GNU/Linux?
- The Idea of Free/Libre Software
- Startup Guide — An Overview
- The KDE Desktop
- The Xfce Desktop
- The Fluxbox Desktop
- Basic Mouse and Keyboard Techniques
- Basic Keyboard Shortcuts
- Using Menus
- Using Dialog Boxes
- Finding Help
- Reference Guide — Some Computer Fundamentals
- A Multitasking and Multiuser Computer System
- Security and User Permissions
- Logging In
- Logging Out
- Creating User and Group Accounts
- Shutting Down Properly
- Customizing the Desktop
- Customizing the Desktop for People with Special Needs
- Customizing for Multiple Languages
- Adding «Quick Launch» Icons to the Task Bar
- Adding Items to the System Menu
- Understanding Folders and Files
- System Files and User Files
- Using a File Manager
- Finding Files
- Using a Printer
- Setting the System Clock
- Terminating Programs That Crash or Freeze
- Connecting to the Internet
- Finding New Programs
- Automatically Updating Programs
- Viruses and Malware
- User Guide — How Do I . . .
- Play Solitaire?
- Quickly calculate some numbers?
- Surf the web?
- View a PDF file?
- Send and receive email?
- Organize my schedule?
- Write a formal letter?
- Edit basic text files?
- Jot notes to myself?
- Use special keyboard characters?
- Schedule reminders and alarms for myself?
- Let the children «paint»?
- Do some serious drawing?
- Touch up and edit images?
- Draw a flowchart?
- Create some charts?
- Learn to type?
- Listen to music files?
- Listen to an audio CD?
- 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.
Related pages
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.