7

When discussing specific Web Apps (such as Facebook, for example), are there guidelines for how things like icon-, button-, and feature-names should be formatted using mini-Markdown?

6

There are no specific guidelines as such, but I often edit out these things:

  • Backticks for highlighting something - please don't do that & let's use backticks only for code.
  • Excessive bold/italics, specially for things like: I want to do this but WHY isn't it Working
  • Needless to say ALL CAPS stuff gets removed out.
  • I'm likely to convert "manual" list items into Markdown formatted ones. Example:

1) Point 1
2) Point 2
3) Point 3

These I change to

  1. Point one.
  2. Point two.

Makes it much easier on the eyes.

  • 6
    Backticks are also good (in my opinion) for things like filepaths and for URLs that you don't want to automatically turn into links. – ale Aug 9 '13 at 12:54
  • 1
    Interested in hearing more opinions specifically about backticks (regarding which I already see first signs of possible disagreement). In fact, some feedback that I received on my use of backticks was what prompted me to ask this question here on Meta. – Yosi Mor Aug 16 '13 at 3:45
3

FWIW, here's what I try to adhere to:

  • Italics when referring to UI elements

    Press the Upload button to upload your image (Example):

  • Backticks for inline code (Example):

    function abc();

  • Four-space indents for code blocks (Example):

    function abc() {
       alert("Boo");
    }
    
  • Backticks when refering to on-screen elements that are not GUI elements (Example):

    Select row 1

  • Backticks also for error messages (Example):

    Error deleting your file

  • <kbd> to specify keys to press (Example):

    Press Ctrl+C to copy

  • Bold for general emphasis:

    Do not do this unless you know what you're doing

Does this make some sense?

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .