Technical Documentation Within SDLC

Action speaks louder than the
words, However, this is
changed due to digital world.
The word has to spoken
precisely and clearly to make
it accessible for the user.
Subscribe @ https://www.meetup.com/Pune-Developers-Community
TECHNICAL DOCUMENTATION

Pune Developer’s CommunityFREE knowledge sharing since Jan 2016
Pune Developer's Community (PDC), We've grown to be a thriving community of
4000+ like-minded people. We have successfully hosted 50+ events in past, in
different walks on software development, i.e
The PDC’s mission is to provide all learning professionals with ways to share their
knowledge and expertise. To accomplish this mission, we serve as a catalyst for
discussion, learning, and innovation.
• Software Architectures & designs
• Cloud Services
• IoT
• Web & mobile apps development
• Software Securities
• Data science,
• Artificial intelligence
• Machine Learning
• Blockchain
• Any many more..

Pune Developer’s CommunityFREE knowledge sharing since Jan 2016
. Organisers .
SUYOG KALE
https://www.linkedin.com/in/suyogkale
DHRUV CHAUDHARI
https://www.linkedin.com/in/dhruvchaudhari
. Past events sponsors’ .

. PDC initiatives .
PDC-Tech Ladies PDC-Nashik

About Me
Kavita is fond of writing and passionate about technology.
She has 5+ years of experience in creating, designing, and
editing Technical writing, End-to-end Software Product
Documentation, and ERP Documentation.
https://www.linkedin.com/in/kavita-gaikwad-375a6617/

•Documentation Skills
•Document of Understanding
•Sample of DOU
•Functionality Flow Document
•Statement Of Work
•Sample of FDD (SOW)
•Technical Analysis Document
•Questions
Knowledge Description

•Thumb rule let it be precise and clear with minimum specified words.
•Usage of pictorial diagrams could avoid more wordiness. This could minimize the length
and complexity. However, the document should be specified with all the instructions.
When required use diagrams, tables, bulleted lists, and images for quick reference.
•Few examples illustrating codes while documenting few technical documentations for
developers could help user to have a quick glance.
•Avoid assumptions and start documenting that is practically observed.
•Step into step for following instructions. Avoid losing procedures.
•Think as user and document accordingly.
•Preview and review: See the presentation or flow of document and review the
document. Additionally, do a testing to verify if the instructions are correctly followed.
Documentation Skills

• Keep headlines and paragraphs short and scannable. Focused users often scan an article for the
part that will answer their particular question. Be sure headlines are short, descriptive, and parallel,
to facilitate scanning.
• Screenshots and GIFs may not be necessary for every article or process, but can be helpful to orient
new users. Crop screenshots tightly around the action to focus attention.
• Cut or tighten redundancies, gerunds, adverbs, and passive constructions.
• Use the simplest word.
• Limit paragraphs to three sentences.
• Technical content uses organization, capitalization, and other formatting to help convey meaning.
Although different articles are organized differently, some formatting tips are consistent
throughout all technical content.
• Capitalize proper names of MailChimp products, features, pages, tools, and team names when
directly mentioned. In step-by-step instructions, capitalize and italicize navigation and button labels
as they appear in the app.

• There are different types of documentation but the major are End
User Documentation and System/Internal Documentation.
End User System/Internal Documentation

Document of Understanding
• A Document Of Understanding (also known as D.O.U) is a
formal document that states the modus operandi and financial
arrangement for a service that shall be provided by a department to
another department within a company or between a holding company and
a subsidiary or between two entities from the same group.
• It is not intended to be a contract but will bind the signatories into the
terms and conditions.
• This is a formal agreement defining conditions under which company
provides the services. The agreement also mentions the chargeback
amount if any on the services.
• This includes scope of assistance and key assumptions.

•Typical areas been addressed.
•Purpose: Why are we doing this project? A purpose statement attempts to answer this.
•Scope of Work: This describes the work to be done and specifies the hardware and
software involved.
•Location of Work: This describes where the work is to be performed, including the
location of hardware and software and where people will meet to do the work.
•Period of Performance: This specifies the allowable time for projects, such as start and
finish time, number of hours that can be billed per week or month, where work is to be
performed and anything else that relates to scheduling.
•Deliverables Schedule: This part lists and describes what is due and when.
•Applicable Standards: This describes any industry specific standards that need to be
adhered to in fulfilling the contract.
•Acceptance Criteria: This specifies how the buyer or receiver of goods will determine if
the product or service is acceptable, usually with objective criteria. See Acceptance
testing.
Areas Addressed

• Special Requirements: This specifies any special hardware or software,
specialized workforce requirements, such as degrees or certifications for
personnel, travel requirements, and anything else not covered in the contract
specifics.
• Type of Contract/Payment Schedule: The project acceptance will depend on if
the budget available will be enough to cover the work required. Therefore a
breakdown of payments by whether they are up-front or phased will usually be
negotiated in an early stage.
• Miscellaneous: Many items that are not part of the main negotiations may be
listed because they are important to the project, and overlooking or forgetting
them could pose problems for the project.

Sample of DOU

•Document that lists all functional requirements for a project and describes the
hardware block diagram as well as the software workflow.
•Used as specification at the early stage of the project and evolve to a final
commissioning document.
•Functional work flow is explained.
•Function details are provided to non- technical/technical user.
Functionality Flow Document

What is Statement of Work (SOW) ?
•A statement of work (SOW) is a formal document that captures and defines the
work activities, deliverables, and timeline a vendor must execute in performance of
specified work for a client. The SOW usually includes detailed requirements and
pricing, with standard regulatory and governance terms and conditions.
Purpose of SOW
•The main purpose of a SOW is to define the liabilities, responsibilities and work
agreements between clients and service providers.
•This defines the scope of the engagement and Key Performance Indicators (KPIs)
for the engagement.
Example of FDD- Statement of work

Sample of SOW

•Acts as the starting point for the execution, and after applying a set of input
values, the application has a definitive outcome and leaves the system at some end
point.
•Document represents the Client’s technical needs.
•These cover technical and graphic design issues, site structure, navigation, page
layout and content, web referencing, and marketing.
•It’s all about data structures, relational database models, choice of programming
languages and tools, algorithms, etc.
•Each page is important to describe for the product specification.
Technical Analysis Documents

•Avoid assumptions for features and functions of your software
•Stick to specifications
•Ensure all specification meet the technical analysis document
•Traceability file(Excel) should cover all testing phase
Example of TAD- Test Case

Sample of T A D

Questions ?

Thank You
FOR YOUR TIME....

Pune Developer’s Community
Thank you
Youtube: https://www.youtube.com/channel/UCxsE4E1FCxBAPuTi92uiRRA
Meetup: https://www.meetup.com/Pune-Developers-Community
Facebook: https://www.facebook.com/punedevscommunity
Twitter: https://twitter.com/PuneDevsCom
Web: http://punedevscommunity.in

Technical Documentation Within SDLC

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (16)

Ähnlich wie Technical Documentation Within SDLC

Ähnlich wie Technical Documentation Within SDLC (20)

Mehr von punedevscom

Mehr von punedevscom (10)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Technical Documentation Within SDLC