Documentation tool

Name : Sarah Saad Salama

ID : 441670357
Outline
● Documentation tools overview
● Importance of documentation tools
● Examples of documentation tools
o ProProfs KnowledgeBase (Online tool)
o Google Docs (Mobile tool )
o Typora (Desktop tool)

2
 Documentation tool
overview :
Documentation tools generate
documents for technical users and
end-users. These documents
encompass all written documents
and materials dealing with a
software product's development and
use.
 Importance of
documentation tools :
Software documentation tools are very important in
software development because are like a compass for your
team. Documentation acts as a reference guide explaining
how it works, how it operates, and how to use it.
documentation often takes the form of manuals and user
guides for sys-admins, support teams, and other users.
Therefore, there is a clear need for a tool to help us create
and save these manuals.

4
 Online Tool

ProProfs KnowledgeBase :

o Overview o How to install it ?

Widely used by organizations across There is no need to install it, you

the globe to achieve their can use the tool online. Search for
organizational objectives. Pricing the tool using its name in any
starts at $29.97 per feature, per search engine.
month. There is a free version, offers
a free trial.

5
o How to use it ?

To create a knowledge base :

From your ProProfs Knowledge Base
dashboard, go to Sites >> + Help Site.

6
o Pros and cons

Pros Cons
• Centralized access to information across • Runs fine on iOS devices, however, at times
multiple devices and browsers. it lags, on other OS.
• Supports 70+ languages that help in catering
to an audience that’s spread across the globe.
• Provide online text editor.
• Contextual help.
• Roles and permissions.
• 600+ fonts & themes.
• Integrate with other tools.

7
o Overall rating

4.6

8

Google Docs :
o Overview
Create, edit, and collaborate with
others on documents. Available as a
mobile app on Android and iOS.
Google Docs is free for the average
user. If you want to purchase a
“Business” version, monthly plans
start at $5 per user.
Mobile Tool
o How to install it ?
If your mobile operating system is
Android, search Google Play
using the name of the application
and click the install button.
If the operating system is iOS,
search the App Store with the
name of the application and click
the GET button.
9
iOS system Android system

10
o How to use it ?

To create a Google Doc on

Android and iOS :
Tap on the plus icon at the
bottom right to start creating
a new document.

11
o Pros and cons

Pros Cons

• Can create, edit, and collaborate with others • It's not ideal if a lot of formatting options are
on documents using the Google Docs app. needed.
• Can create new documents or edit existing • Slow performance on large documents.
files.
• Sharing documents and collaborate in the
same document at the same time.
• Working anywhere, anytime - even offline.
• Add and respond to comments.

12
o Overall rating

4.7

13
 Desktop Tool

Typora :

o Overview o How to install it ?

Typora gives you a seamless Use any search engine to write the
experience as both a reader and a URL of the site
writer. It is a simple document reader "https://typora.io/". Click the
and writer, a plain text format that’s download button at the top right
easy to read and write. Free version of the page, choose your device's
available. operating system then choose
processor architecture 32-bit or
64-bit. After clicking the
installation process will begin.
14
15
o How to use it ?

To open new folder :

You could select a folder in the
open file dialog popup from File
→ Open menu to open a folder in
Typora.
Also you can open folder from
context menu of specific
file/folder. Other supported
options can be found :
 Open in New Window
 Undo File Operations
 New File/Folder
 Duplicate
 Rename
 Delete (Move to Trash)

16
o Pros and cons

Pros Cons

• Immediately renders what's typed on the • Typora is still in beta and may be prone to
screen in Markdown format. This helps users changes or bugs
to have a better understanding of how their • There currently is no portable version
document is being formatted. available.
• Typora has clean yet beautiful built-in
themes and allows for users to create new
themes using CSS.

17
o Overall rating

4.5

18
“ Thanks!
Any questions?

19