Как написать статью для сообщества iKoula
zh:如何写一篇文章为社区 iKoula
ro:Cum să scrie un articol pentru comunitatea iKoula
pl:Jak napisać artykuł do Wspólnoty iKoula
fr:Comment rédiger un article pour la communauté iKoula
Эта статья является результатом автоматического перевода, выполняемого программного обеспечения. Вы можете посмотреть исходный статьи здесь.
ikoula хочет расти его технической базы знаний. Цель этих блогов является предоставление учебников, хорошо написаны, понятной и на различные темы, связанные с услугами, предоставляемых принимающей. Для того чтобы иметь определенные единство стиля письма, мы описали следующие рекомендации.
Философия
Статьи базы знаний записываются с читателями в виду ! Это означает, что автор статьи должен :
- Не следует делать предположений о техническом уровне читателя.
- Как можно более четко описывайте явно каждый шаг.
- Проверить свои учебники, предпочтительно на новую установку, чтобы убедиться, что они работают "царапины от ".
- Напишите статью, чтобы быть понятны всем.
Структура
Статьи пишутся с подробные шаги и быть как можно более четкими. Чтобы быть уверенным, что читатель точно следовать статье и лупы не Одношаговая, статьями ikoula должны быть написаны с помощью инструкции и объяснения. Другими словами на каждом этапе должно быть объяснение команды или операции и он должен отображаться.
Когда он вещает количество информации, она может быть соблазн объединить онлайн заказов или просто перечислить их без объяснения причин. Но это не является предпочтительным методом для понимания читателей.
Когда игрок проверяет элемент, это заманчиво просто скопировать /Вставьте данные представлены, без понимания что такое обучение. Особенно, если предметом незнакомой ему. Вот почему статей в базе знаний ikoula иметь цель учебных и образовательных, обеспечивая объяснение для каждого позволяет читателю понять представленной информации.
Эти объяснения играют важную роль в понимании, особенно если есть много информации, чтобы пройти. Когда есть много изменений, как в файле конфигурации или длинные установки, мы рекомендуем что подробно, насколько это возможно, каждое изменение, которое должно быть сделано.
Две вещи должны быть избегать :
- Длинные конфигурационные файлы Рекомендуемые копия без объяснения причин.
- Скрипты для загрузки и запуска ускорить установку или настроить процесс, если они явно подробно.
Кроме того если статья описывает сложной установки, особенно когда речь идет о несколько серверов, мы рекомендуем включить раздел подробно цель руководства.
Если вы используете диаграммы, не забудьте включить легенде, для того чтобы быть понятны всем.
Включить автоматическое обновление комментариев