Pseudocode 📝

Pseudocode is a simplified way of writing out the steps of an algorithm without worrying about the rules of a specific programming language.

It helps programmers:

• plan before coding

• spot errors more easily

• explain logic to others

• write readable documentation

• transition smoothly from idea to code

Key advantages:

• Easier to read than real code

• Faster to write and update

• Good for testing logic before coding

• Helps with collaboration between tech and non-tech team members

• Ideal bridge between flowcharts and final code

QCAA Pseudocode Rules¶

In Digital Solutions, pseudocode is the standard way to represent algorithms. Since schools use different programming languages, the syllabus uses pseudocode to ensure consistency. The QCAA has set specific rules for how it must be written.

Keywords¶

KEYWORDS should be written bold and capitalized.

Keywords do not have to be valid programming language words as long as they clearly convey the intent of the line of pseudocode.

Calculations¶

Pseudocode should clearly indicate what is happening at each step, including formulas of calculations.

For example: CALCULATE net is not as clear as CALCULATE net = gross − tax

Naming Conventions¶

Use snake case naming convention for variable names with multiple words, subroutines, methods and functions.

Snake case is a convention where all words are in lowercase and spaces between words is replaces with an _

For example: VAR file_name

Font¶

Use a mono-space typeface when writing algorithms on computer:

Windows mono-space fonts:

• Courier New

• Consolas

• Cascadia Code

• Cascadia Mono

Mac mono-spaced fonts:

• Andalé Mono

• Consolas

• Courier

• Courier New

Variables¶

To input or output values, common words can be used as keywords.

For example:

• INPUT mark

• WRITE "the total is" count

• PRINT x, y

• DISPLAY name, result

• READ name from list.txt

• OUTPUT average

Pseudocode uses the assignment operator, = to assign values.

For example:

• CALCULATE net = gross - tax

Modularisation¶

All pseudocode modules start and ends with the BEGIN and END keywords.

Main algorithm:

BEGIN
    statements
END

Defining procedures, subroutines, methods or functions

BEGIN function_name
    statements
END

Calling procedures, subroutines, methods or functions

statements
function_name
statements

Iterations¶

There are three main types of loops — each has a clear start and end, with the statements within the loop indented.

Post-test loops

REPEAT
    statements
UNTIL condition

Pre-test loop

WHILE condition
    statements
ENDWHILE

Counted loop

FOR count = start_val TO end_val
    statements
NEXT count
ENDFOR

Selection¶

A control structure used for decisions or branching and choosing alternate paths. The beginning and end of these structures are indicated with keywords.

IF statement

IF condition THEN
    statements
ENDIF

IF...ELSE statement

IF condition THEN
    statements
ELSE
    statements
ENDIF

IF...ELIF...ELSE statement

IF condition THEN
    statements
ELSE IF condition THEN
    statements
ELSE
    statements
ENDIF

MATCH statement

In most other languages these are called switches

SWITCH test_variable
    CASE option
        statements
    CASE option
        statements
    CASE option
        statements
ENDSWITCH

SQL¶

The QCAA does not have any opinion about the pseudocode for SQL. Therefore, just write your SQL code like you would use it in your program.

Pseudocode in Your Assignment¶

What to Include¶

Your assignment have limited space, so you will not be able include all your algorithms as pseudocode. That presents the question, what code should you include?

Ultimately, the pseudocode presented in your assignment should demonstrate your coding skill. Choose the algorithms that you are most proud of, or that you found the trickiest.

Also keep in find that you should be demonstrating all six of the algorithm basic building blocks:

• sequence

• assignment

• conditions

• selection

• iteration

• modularisation

Annotating Pseudocode¶

Pseudocode in your assessments should not stand alone. Annotations — short explanatory notes attached to your pseudocode — provide evidence across multiple criteria, not just Communicating.

What criteria do annotations evidence?¶

IA1

• Comprehending — annotations that explain the interrelationships between proposed data structures and user experiences, and that contextualise your pseudocode to the identified problem rather than leaving it generic, contribute to this criterion.

• Synthesising — annotations that connect algorithms to specific programming requirements, user-experience requirements, and success criteria demonstrate synthesis at the upper performance level.

• Communicating — annotations are identified in the syllabus as a specific language feature for communicating. Well-placed, concise annotations that aid clarity contribute here.

IA2 and IA3

• Determining and Synthesising — annotations that link pseudocode explicitly to success criteria, and that demonstrate how programmed components address the identified problem, support evidence of synthesis at the upper performance level.

• Generating — annotations that indicate the functionality, useability, and efficiency of coded components provide evidence that the generated solution is purposeful and meets the determined success criteria.

• Evaluating — annotations that connect code behaviour to success criteria, and that explain how components interact to address the problem, support critical evaluation judgments.

• Communicating — concise, well-organised annotations that use technical language accurately contribute here.

What annotations should say¶

The focus of annotations differs slightly across each assessment.

IA1 — Technical Proposal

In IA1, pseudocode represents proposed algorithms that do not yet exist as working code. Annotations should:

• link algorithms explicitly to success criteria — explain how the algorithm addresses a specific criterion

• explain design decisions, particularly where you have chosen one approach over another

• clarify how the algorithm connects user experience to data behaviour

IA2 — Digital Solution

In IA2, pseudocode and annotated code represent programmed components of your working prototype. Annotations should:

• link code or pseudocode explicitly to the success criteria it addresses

• demonstrate knowledge and understanding of programming features relevant to the task

• explain the functionality, useability, and efficiency of coded components to support your evaluation

IA3 — Digital Solution (Data Exchange)

IA3 has a strong focus on data exchange and security. Annotations should:

• explain how programmed components address the identified security strategy

• connect algorithms to success criteria relating to data confidentiality, integrity, or availability

• support your evaluation of the functionality, useability, and efficiency of the solution

How to format annotations¶

Annotations can be added:

• as callout boxes or text boxes in a multimodal response, with arrows pointing to specific lines

• as inline comments in code (# comment) when submitting code pages

• as margin notes or labels beside a pseudocode block

Keep annotations concise and specific. An annotation that says “this loop iterates through the records” adds nothing — the pseudocode already shows that. A useful annotation explains why, or links to a criterion: