INTRODUCTION

Every guide needs to follow some rules and guidelines to ensure quality content and ease-of-use for all Linux Academy students.

The editor toolbar contained at the bottom of the guide writing text box, includes the formatting options needed to style your guide appropriately.

SECTIONS

Every Linux Academy Guide should use sections to segment each portion of the guide. Use the ‘A’ button in the editor toolbar to select “Header 1” for each section title.

You can also make sub-sections by selecting the “Header 2” option, under the ‘A’ button. Sub-sections help to divide up larger tasks contained in a single heading.

Required Sections

Each guide should have an “Introduction” section describing the basic goals of the guide. It should make clear what skills and topics the guide covers, and should be short and to-the-point.

Different stages or steps of the guide should then have their own sections, splitting up longer tasks into sub-sections.

You may also want to include a section about “Next Steps” the reader can take to study the topic further and learn more.

Section Order

When you write a guide, you should think about the order of your sections. Is this the most logical order for a new reader to follow, or just the order that you happened to write your guide?

Images

Feel free to upload images if they help to illustrate your guide, but do not add images if they do not add any value to the guide. Do add images if they make your guide more complete and enrich your readers’ understanding.

Grammar

Try to write in clear language that follows the standard practice of your language. Remember to check the spelling of your words, and reread through your work before posting. Websites like grammar.ly and hemingwayapp.com can assist in editing English-written guides.

Code Snippets

Linux Academy’s community pages support some syntax highlighting for code snippets. To activate the highlighting:

  1. First, write out your code in the editor of your choice.
  2. Next, paste your code into your guide, selecting the ‘Format as Code’ option from the box that appears on the screen.
  3. Highlighting will take effect on the next page load.

You should end up with something like this:

var myObject = { 
init: {
alert('You called "init" on a myObject');
},
}

var instance = new myObject();
instance.init();
Sources / Plagiarism

Please cite your sources at the end of your guide. Additionally, if there are websites where you can download software, please put a set of links a the end of the article, so that people can quickly locate all of the materials needed to use your guide.

Additionally, all guides are checked for plagiarism.

Comments are disabled for this guide.