Pseudo code document template

Log in Social login does not work in incognito and private browsers. Please log in with your username or email to continue. No account yet? Create an account.

Edit this Article. We use cookies to make wikiHow great. By using our site, you agree to our cookie policy. Cookie Settings. Learn why people trust wikiHow. Download Article Explore this Article parts. Tips and Warnings. Related Articles. Article Summary. Part 1. Know what pseudocode is. Pseudocode is a step-by-step written outline of your code that you can gradually transcribe into the programming language.

Many programmers use it to plan out the function of an algorithm before setting themselves to the more technical task of coding. Understand why pseudocode is useful. Pseudocode is used to show how a computing algorithm should work. Coders often use pseudocode as an intermediate step in programming in between the initial planning stage and the stage of writing actual executable code. Some other uses of pseudocode include the following: Describing how an algorithm should work.

Pseudocode can illustrate where a particular construct, mechanism, or technique could or must appear in a program. Explaining a computing process to less-technical users. Computers need a very strict input syntax to run a program, but humans especially non-programmers may find it easier to understand a more fluid, subjective language that clearly states the purpose of each line of code.

Designing code in a group setting. High-level software architects will often include pseudocode into their designs to help solve a complex problem they see their programmers running into. If you are developing a program along with other coders, you may find that pseudocode helps make your intentions clear. Remember that pseudocode is subjective and nonstandard. There is no set syntax that you absolutely must use for pseudocode, but it is a common professional courtesy to use standard pseudocode structures that other programmers can easily understand.

If you are working with others on a project—whether they are your peers, junior programmers, or non-technical collaborators—it is important to use at least some standard structures so that everyone else can easily understand your intent. If you are enrolled in a programming course at a university, a coding camp, or a company, you will likely be tested against a taught pseudocode "standard". This standard often varies between institutions and teachers. Focus on the main purpose of pseudocode.

It can be easy to revert to writing in code once you hit your stride. Remembering the purpose of your pseudocode—explaining what each line of the program should do—will keep you grounded while creating the pseudocode document.

Part 2. Use a plain-text editor. It can be tempting to use a word processor e. Start by writing down the purpose of the process. Dedicating a line or two to explaining the purpose of your code will help set up the rest of the document, and it will also save you the task of explaining the program's function to each person to whom you show the pseudocode. Each statement in your pseudocode should express just one action for the computer.

In most cases, if the task list is properly drawn, then each task will correspond to one line of pseudocode.

Consider writing out your task list, then translating that list into pseudocode, then gradually developing that pseudocode into actual, computer-readable code. Use white space and indentation effectively. Using white spaces between "blocks" of text will help keep different components of your pseudocode isolated, and indenting different pieces of each block will indicate that those pieces of pseudocode go under a less-indented section.

For example, a section of pseudocode that discusses entering a number should all be in the same "block", while the next section e. Capitalize key commands if necessary. Depending on your pseudocode requirements or the environment in which you're publishing the pseudocode, you may need to capitalize commands that will remain in the actual code. For example, if you use "if" and "then" commands in your pseudocode, you might want to change them to read "IF" and "THEN" e.

Write using simple terminology. Remember, you're writing about what the project will do , not summarizing the code itself. This is especially important if you're writing pseudocode to serve as a demonstration for a customer who doesn't know coding, or as a project for a beginner programmer.

Keep your pseudocode in the proper order. While the language you use to modify your pseudocode should be simple, you still need to keep each piece of your pseudocode in the order in which it needs to be executed.

Leave nothing to the imagination. Everything that is happening in the process must be described completely. Pseudocode statements are close to simple English statements. Pseudocode does not typically use variables, but instead describes what the program should do with close-to-real-world objects such as account numbers, names, or transaction amounts.

Even if there is no standard for pseudocode, it will be easier for other programmers to understand your steps if you use structures from existing sequential programming languages. Please enter your email address.

You will receive a link and will create a new password via email. Please briefly explain why you feel this answer should be reported. Set of principles and guidelines that can be tailored and applied to specific situations. Proven Methodology used for successful implementation. This document specifies various functional specification required for Techies to understand the functional requirement of Form or Report Customization and design..

This is prepared by Functional consultant to clarify the spec to Techies. For any component like Report, Interface etc we have to first get the requirements as to what is the source , destinations, what data should be moved and what functional validations would be required etc.

All this would go into the MD Generally written by a non-technical people like Business Analysts or Functional Consultants. This is technical specification prepared by the programmer based on MD MD is the technical document that is written to fulfill the functional requirement specified in MD It is a methodology that allows the programmer to represent the implementation of an algorithm. Often at times, algorithms are represented with the help of pseudo codes as they can be interpreted by programmers no matter what their programming background or knowledge is.

Pseudo code, as the name suggests, is a false code or a representation of code which can be understood by even a layman with some school level programming knowledge. A programmer implements an algorithm to solve a problem. Algorithms are expressed using natural verbal but somewhat technical annotations. Advantages of Pseudocode Improves the readability of any approach. Acts as a bridge between the program and the algorithm or flowchart. Also works as a rough documentation, so the program of one developer can be understood easily when a pseudo code is written out.

In industries, the approach of documentation is essential. The main goal of a pseudo code is to explain what exactly each line of a program should do, hence making the code construction phase easier for the programmer. How to write a Pseudo-code? Arrange the sequence of tasks and write the pseudocode accordingly. Start with the statement of a pseudo code which establishes the main goal or the aim. Example: This program will allow the user to check the number whether it's even or odd.

The way the if-else, for, while loops are indented in a program, indent the statements likewise, as it helps to comprehend the decision control and execution mechanism. They also improve the readability to a great extent.