Girl in Tech

There are various types of Technical documentation that organization maintain to run their day to day business. The documents are prepared for different audiences from customer to development team. These documents provide product overview, guide the internal process, and assist the sales and marketing team.  There are 15 types of Technical documentation: 1. Product Manuals/ Support Guides 2. User Guide 3. Project Plan 4. Release Notes 5. API Documentation 6. Business Continuity Plan (Includes DR - Disaster Recovery) 7. Release Management Plan 8. White Papers 9. FAQ/ Troubleshooting guides 10. Case Studies 11. Marketing Documents 12. SOW (Statement of Work) 13. RFPs and Proposals 14. Business Standard Documents 15. HLDs and LLDs We will try to cover all of them in detail in our next blog post. Keep reading :)

Six phases of DDLC: DDLC is a systematic way of developing technical documentations in standard format. It consist of six areas: Phase 1: Requirement Gathering Phase 2: Planning the content Phase 3: Developing the content Phase 4: Reviewing the conent Phase 5: Publishing the content Phase 6: Maintaing the content This cycle is excellent if it works with everything else in your organization; e.g., development of product cycle. Implementation of DDLC and its adherence is not that easy. Most of the tech organizations in India maintain the content in traditional formats like PDF and Word. So, it is not easy to maintain and update those documents timely unless they have proper content review cycle.  How Relevant is DDLC for the team? The entire process of creating and maintaining the documents is critical for the knowledge management of the team. Having a documented track of all the product summary strengthens the foundation of the product range of the organization. 

What is SOW? SOW is a document that describes the terms and objectives of a project or service contract, including the scope of work required to meet the objectives, costs, deliverables, timelines, and other expectations. The document is shared by the vendor to the customer.  SOW Includes 1. Purpose: Purpose of project 2. Scope of Work: requirements of customer 3. Period of Performance: Expected year of completion of delivery of the solution.  4. Deliverables Schedule: scheduled delivery of milestones of project 5. Application Standards: Machines used in project, mechanism used to deliver the project, etc.  6. Acceptance Criteria: Customer defined milestone achievements to accept the project. 7. Payment Schedule: start of project, middle of project, end of project  8. Signoff: customer and the vendor sign off  SOW Template for EPM (Employee Performance Management) Purpose:

Cloud Computing Currently, over 90% of the organizations in the world are using cloud computing services to host their business infrastructure. The entire infrastructure set up is provided over the internet by a remote data center provided by a cloud service provider. The cloud infra requirements works on a consumption based pay-as-you-go model, organizations pay for the cloud services they use and not for comprehensive services all at once. The most common daily use examples of cloud computing is Google photos, Google drive, Gmail, Amazon Prime, Microsoft OneDrive, etc.  Image Source: Cloud Computing Let’s dive deep into various aspects of cloud computing. Advantages of Cloud Computing: Compared to the traditional IT infra set up, cloud computing offers various advantages. These are: Lower IT Cost : Organizations adopting cloud infrastructure are free of cost and effort of purchasing, installing, configuring, and managing the on-prem infrastructure. Improve agility and time to va...

Image Source: Tech Writers Tribe Agile Manifesto  With the adoption of Agile Manifesto, software development has changed its trajectory and so is the documentation. Agile software development paved the way for the technical documentation to change from normal documentation to Agile documentation process. One of the core principles in Agile Manifesto is Working software over comprehensive documentation”  This principle introduces two things for technical writers:   Stronger collaboration with the developers’ team to build documentation in line with the software development lifecycle. Minimum viable documentation that is good enough so that your customers can use that documentation right away. Software Developers and Technical Writers In Agile documentation, both the writers and developers respond to change quickly instead of following a predefined plan. Agile documentation is nothing but producing documentation based on Agile Manifesto. Technical writers work closely ...

 Release Note for the product EPM (Employee Performance Meter) EPM (Employee Performance Meter) Release Notes Release Details  Product/Service name EPM Version number V 0.3 Release date Feb, 2023 Purpose Product Enhancement Last Release V 0.2, 25 th Oct, 2022 Overview EPM is a web application that is designed to provide instant access to employees to multiple services in an organization related to performance review, appraisal cycle, quarterly feedback, annual feedback, etc., This application is available for web browser, as well as for mobile devices (iOS and Android device).  Features Employee Performance review window Feedback Section to employee Annual Performance Chart Quarterly Discussion Schedule Request Goal Setting Forum    Challenges in the Current Version The current version of EPM has multiple challenges which has been address...