[Writing for CS] 10. Algorithms & 11. Graphs, Figures, and Tables

10. Algorithms 

• Formalisms
  
  1. Literate code style (Author recommended, If algorithm explanation is not given)
  2. Prosecode style: Text with embedded code, rather than as code with textual annotations. Prosecode style of presentation is only effective when the concepts underlying the algorithm have been discussed before the algorithm is given.
  3. Pseudocode style
  4. List style
• Level of Detail
  • Don't provide too much detail.
  • Use text rather than mathematics if the former is sufficiently clear.
• Notation/Cautions
  • Use x_i rather than x[i]
  • Don't use "*" or "x" to denote multiplication. Use \times or \dot and in any case multiplication is often implicit.
  • Avoid using constructs from specific programming languages such as ==, a=b=0, a++, and for(i=0;i<N;i++)
  • Take care with variable names of more than one character - don't use "pq" if it might be interpreted as "p \times q"
  • Use a simple mathematical notation to unambiguously specify the structure.
  • Be consistent. Same input and output
• Asymptotic Cost
  • Big O notation is used for asymptotic analysis and an upper bound on the asymptotic cost.

11. Graphs, Figures, and Tables

• Each figure and table should always be introduced and discussed in the main text.
•  Graphs
  • Graphs should be simple, with no more than a few plotted lines and a minimum of clutter. Minimize use of unnecessary elements and remove all decorations.
  • If the graph is being used to demonstrate variation in output values for a range of input values, x-axis should be used for the parameter being varied, or the input; the y-axis is for the function of the parameter,  or the output.
  • Consider using greys > colors > or line thickness rather than dots and dashes to distinguish between lines.
• Diagrams
  • Elements should be consistent; NO data is both ovals and boxes.
  • Remove unnecessary materials and write-only. Use only on prominent stuffs.
• Tables
  • Put the sense of table hierarchy -Not all the elements are at the same table. Headings and contents must be differentiated by case.
  • Units are mentioned explicitly.
  • Don't use many (horizontal or vertical) separated rules.
• Captions and Labels
  • Though it is common for captions to be only a few words, it is preferable for captions to fully describe the figure’s major elements.
  • The caption is an appropriate place to explain important details, especially since these would otherwise interrupt the flow of the main text.