Please follow these guidelines when working on the FAQ pages for the 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 and 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 as a good example for style and structure.
- The BigAdmin FAQs should focus on system administration and troubleshooting information.
- Provide pointers to BigAdmin 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 BigAdmin and docs.sun.com sites.
- Provide a list of related FAQs if available.
Important Information Make sure you provide pointers from your FAQ index to its corresponding hub or the BigAdmin site. And, conversely, provide pointers from the BigAdmin hub to its corresponding FAQ. It is important to provide a connection between these two sites.
Sign up or Log in to add a comment or watch this page.