Translations: English Japanese Italian Как я могу принять участие в улучшении FAQ пользователей GlassFish? Помощь любого типа приветствуется и поощряется. Такая помощь будет полезна в следующий раз, когда вы или кто-то еще столкнется с проблемой: "Как я могу ...?". Для создания нового FAQ или редактирования существующего нужно создать учетную запись. Нажмите 'Log In' вверху страницы, чтобы зарегистрироваться, если это необходимо. Если у вас есть вопросы или пожелания к этому FAQ, пожалуйста, напишите на [docs@glassfish.java.net]. Вы также можете подписаться на рассылку на странице почтовых листов GlassFish. Как лучше участвовать
-
- Опубликовать ответ на вопрос, который еще не имеет ответа* (вопросы, перечисленные в User FAQ Wish List секции на главной странице FAQ). Возможно вы сталкивались с подобной проблемой и смогли её решить. Возможно вы писали об этой теме в блоге или отвечали на подобный вопрос в форумах. Если у вас есть опыт, которым вы можете поделиться, сделайте это.
-
- Опубликовать новый вопрос, для которого у вас уже есть ответ.* В первую очередь убедитесь, что этот вопрос еще не включен в FAQ (если он уже включен - смотрите информацию низу). Потом спросите себя - действительно ли этот вопрос возникает так часто. Это вопрос, который уже много раз задавался и был решен в списке рассылки? Это вопрос, скорее всего будут задавать многие (особенно новые) пользователи? Тогда добавляйте его.
-
- Добавить информацию к FAQ созданному кем-то другим.* Если у вас есть информация, которую можно добавить в FAQ, чтобы улучшить его, добавьте её. Это может быть детальный пример (примеры - это всегда хорошо!), решение, которое заработало у вас когда уже ничего не помогало или клевый совет, который стоит знать другим людям.
Формат FAQ Записи FAQ должны использовать единые соглашения о наименовании и следовать единому формату. Это действительно очень важно. Пожалуйста, следуйте этим правилам:
-
- Используйте префикс 'Faq' когда задаете имя новой страницы*, и сделайте оставшуюся часть имени короткой но описательной. Например, имя этой страницы FaqContributeToUserFAQ.
-
- Добавляйте новые FAQ в соответствующие категории.* Если вы не видите соответствующей категории на главной странице GlassFish User FAQ, добавьте её. Вам также следует добавить соответствующую запись в оглавление, чтобы пользователи могли легко найти добавленную вами запись. Соблюдайте формат других записей на главной странице.
-
- Повторите ваш вопрос в заголовке страницы с ответом, и убедитесь что вопрос совпадает с тем который опубликован на главной странице FAQ.* например, вопрос Как я могу внести вклад в этот FAQ для пользователей? написан как на главной странице GlassFish User FAQ, так и на странице с ответом. Пример неправильного использования, это вопрос How do I contribute to this User FAQ? и ответ Contributing to this FAQ.
-
- Используйте заголовок среднего размера для вопроса в начале ответа* (!! разметка). Например, How do I contribute to this User FAQ? вверху страницы имеет немного больший размер текста и другой цвет. Это достигается за счет использования макроса разметки !!.
-
- Выполняйте следующие простые рекомендации.* Имя GlassFish содержит F в верхнем регистре. Например, GlassFish вместо Glassfish. Номер версии указывается с v в нижнем регистре. Например, v2 или v3 вместо V2 или V3. Также используйте маленькую v вместо большого слова version. Например, используйте v3 вместо version 3. Эти рекомендации соблюдаются не везде на Wiki, но им следует следовать при добавлении нового содержимого.
Требования к содержимому FAQ
-
- Соблюдайте требования к формату описанные выше.* Единообразие очень важно.
-
- Следите, чтобы FAQ оставался ориентированным на пользователей, нежели на разработчиков.* Для вопросов связанных с разработкой обратитесь к GlassFish Developer FAQ.
-
- Убедитесь что заголовок вашего FAQ это реальный вопрос, который действительно будет задан.* Он должен быть коротким и ясным, желательно не длинее одной строки и содержать сжатое описание затрагиваемой темы..
Для создания нового FAQ
- Нажмите 'Log In' вверху страницы и пройдите авторизацию. Вам нужно зарегистрироваться, если у вы еще этого не сделали. Прочитайте Как зарегистрироваться?, чтобы узнать подробнее о регистрации.
- Выберите GlassFish User FAQ слева, если вы еще не на этой странице. Откроется страница GlassFishUserFAQ.
- Выберите 'Edit' вверху страницы. Возможность редактирования не доступна пока вы не прошли авторизацию в Wiki. Если вы прошли авторизацию, но возможности редактирования не появилось - прочитайте Почему я не могу редактировать страницы Wiki GlassFish?.
- Перейдите к соответствующей категории (такой как Установка) и добавьте ваш вопрос в список, следуя формату формату используемому для других вопросов и уделяя внимание руководствам представленным выше. Если вы не видите подходящей категории, создайте её сами. Важно: Если вы добавляете новую категорию вы также должны добавить соответствующую запись в оглавление страницы. Соблюдайте формат используемый для других записей.
- Проверьте вашу запись, измените, если требуется, затем сохраните.
- Выберите ваш вопрос в списке на странице GlassFishUserFAQ и добавить информацию на страницу с ответом.
- Проверьте вашу информацию, измените, если требуется, затем сохраните..
Для редактирования существующего FAQ
- Нажмите 'Log In' вверху страницы и пройдите авторизацию. Вам нужно зарегистрироваться, если вы еще этого не сделали. Прочитайте Как зарегистрироваться?, чтобы узнать подробнее о регистрации.
- Выберите GlassFish User FAQ слева, если вы еще не на этой странице. Откроется страница GlassFishUserFAQ.
- Выберите ссылку на вопрос, который вы хотите отредактировать. Откроется страница вопроса.
- Выберите 'Edit' вверху страницы. Возможность редактирования не доступна пока вы не прошли авторизацию в Wiki. Если вы прошли авторизацию, но возможности редактирования не появилось - прочитайте Почему я не могу редактировать страницы Wiki GlassFish?.
- Отредактируйте содержимое отображаемой страницы.
- Проверьте ваши изменения, измените, если требуется, затем сохраните.
|