View Source

Please follow these guidelines when working on the FAQ pages for the {nl:BigAdmin} wiki.
# Create an FAQ index page to group related FAQs. There are two examples provided for types of FAQ index pages: [Link FAQ Index Example|Link FAQ Index Example] and [Include FAQ Index Example|Include FAQ Index Example]. Click the Info tab on either of these pages to copy the file to create your own index.
# Each individual FAQ (a question and corresponding answer) should be documented on its own page, which supports reuse and modularity. Each question should be a head 2 on the individual pages for maximum reuse.
# Use the question for the FAQ page name. Page titles have a 255 character limit.  As much as possible, use complete and descriptive titles for the FAQ pages to help set the question's context and to enable better search results. If you want the page title in the page's url for searchability, don't add a "?" to the page title.
# Use the [NetBeans FAQ|http://wiki.netbeans.org/wiki/view/NetBeansUserFAQ#section-NetBeansUserFAQ] as a good example for style and structure.
# The {nl:BigAdmin} FAQs should focus on system administration and troubleshooting information.
# Provide pointers to [BigAdmin|http://www.sun.com/bigadmin/home/] or other Sun information sources to answer questions.  If an answer already exists somewhere else, link to it\!  This a good way to promote the {nl:BigAdmin} and docs.sun.com sites.
# Provide a list of related FAQs if available.
{info:title=Important Information}
Make sure you provide pointers from your FAQ index to its corresponding hub or the {nl:BigAdmin} site. And, conversely, provide pointers from the {nl:BigAdmin} hub to its corresponding FAQ. It is important to provide a connection between these two sites.
{info}

The individuals who post here are part of the extended Sun Microsystems community and they might not be employed or in any way formally affiliated with Sun Microsystems. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Sun nor any other party necessarily agrees with them.

Copyright 1994-2009 Sun Microsystems, Inc.
Powered by Atlassian Confluence
Sun Guidelines on Public Discourse Privacy Policy Terms of Use Trademarks Site Map Employment Investor Relations Contact