Return to Answer

• Use user-friendly download buttons when recommending software: How to post links that integrate with the Software Center?

• Break up your text, leave room to breathe.

  A wall of text can look tedious and some people just won't read it. Break up your text into small paragraphs of a few sentences. Point out where the important information is.

• For commands that users need to type into their terminal use backticks so that the site renders it in a monospace font so it's easier to distinguish what is a command and what is part of the surrounding text.

• Don't use $'s for answers in the terminal (unless you're also showing output).

• If something is a series of steps, break it down into a numbered list so it's easier to read instead of one line.

• Don't overformat your questions and answers, they become hard to read, remember that less is more, not more.

• Question titles should ideally be actual questions, beginning with a capital letter and ending with a question mark.

  • Good example:

    How can I upgrade to Ubuntu 12.10?

  • Bad example:

    upgrade ubuntu 12.10

  You should not force the title to be a question, but at least try to write a meaningful title.

###Good formatting####

• Break up your text, leave room to breathe.

  A wall of text can look tedious and some people just won't read it. Break up your text into small paragraphs of a few sentences. Point out where the important information is.

• For commands that users need to type into their terminal use backticks so that the site renders it in a monospace font so it's easier to distinguish what is a command and what is part of the surrounding text.

• Don't use $'s for answers in the terminal (unless you're also showing output).

• If something is a series of steps, break it down into a numbered list so it's easier to read instead of one line.

• Don't overformat your questions and answers, they become hard to read, remember that less is more, not more.

• Question titles should ideally be actual questions, beginning with a capital letter and ending with a question mark.

  • Good example:

    How can I upgrade to Ubuntu 12.10?

  • Bad example:

    upgrade ubuntu 12.10

  You should not force the title to be a question, but at least try to write a meaningful title.

###Good formatting###

• If an image is too large to fit on the page, instead of reminding the user that they can right click it and select show image, make it a link to a larger version of the same image. Don't use pre-formatted linking thumbnails with extraneous information in them.

• Images and screen shots should be on their own paragraph; Make sure the image referece in the Markdown has a blank like before and after it. If you annotate an image, you can use <br>*Picture of a cat* on the same line to stick the text right onto the image. Use this technique sparingly.

• Images should not be used if the sole purpose of the image is to display text (terminal or otherwise). An image takes more bandwidth and is does not support screen reading software. Text should instead be copied into a quote or code block as appropriate.

• If an image is too large to fit on the page, instead of reminding the user that they can right click it and select show image, make it a link to a larger version of the same image. Don't use pre-formatted linking thumbnails with extraneous information in them.

• Images and screen shots should be on their own paragraph; Make sure the image referece in the Markdown has a blank like before and after it. If you annotate an image, you can use <br>*Picture of a cat* on the same line to stick the text right onto the image. Use this technique sparingly.

• Images should not be used if the sole purpose of the image is to display text (terminal or otherwise). An image takes more bandwidth and is does not support screen reading software. Text should instead be copied into a quote or code block as appropriate.