This Postman guide was written by developers, for developers.
By: Cindy Le| Jeffrey Lau
Step 1: Go to the Postman website.
Step 2: Create a Postman account:
- Click Sign In button at top of the navigation bar.
- Click the Create Account option.
Step 3: Click Download on the homepage.
Step 4: Run the installer appropriate to your platform.
Step 5: Set up your workspace by selecting the tools you need:
- Click Save My Preferences, and a Startup Screen will appear.
View the documentation for usage information.
This guide was written with Postman Version 7.19.1 on the desktop application and NOT the web application. There are separate instructions for the web application of Postman. The desktop application can be used on macOS, Windows x32/x64, and Linux x64.
To get the most out of this guide, you will need:
- A computer installed with either:
- macOS 10.10 or higher
- Windows 8 or higher
- Linux
- A keyboard and mouse or trackpad
- Stable internet connection
- Web browser (preferably Google Chrome)
- Familiarity with computer functionality and overall GUI (Graphical User Interface) layouts
This Postman Documentation guide is written based on the "Digital Ocean" style guide. The voice and tone used is friendly and informative. This is written with an humanized and active voice. The guide has little jargon and no fluff or fillers between headers. The focus is to deliver an informative and helpful guide without making it boring.
The guide is written with the reader in mind. Steps were removed or condensed to enhance the flow and create a document that is easy to understand. Heading sizes was carefully considered to provide readers with the ability to scan the document and effortlessy locate sections. The purpose of this was to inform and help readers understand what Postman is.
This guide integrates images with highlights to help guide the reader through each step. The screenshots were taken as the guide was written, going through each section step by step in the application. This provided insight on how the reader would use the guide and the steps they should take.
We met face to face to collaborate ideas and communicated through Slack. This made collaborations easier with a flexible and dynamic environment.
This guide was initially written in Google Docs and then converted into markdown through VSCode with an extension called "Markdown Preview Enhanced". This extension gives you a side-by-side view of the markdown code and the page.
This guide uses the Jeckyll Theme "just-the-docs" on GitHub pages.