Process of Documentation

Duration: 8 min

This video lesson is available to enrolled students.

Return to /learn/RSSB-BASIC-COMPUTER-INSTRUCTOR/paper-2-system-analysis-and-design/software-documentation-and-software-requirements-specification-srs/documentation-needs-and-types/asset-process-of-documentation after enrolling

Inside: a video lesson and guided study material.

Module outline

  1. About the Course: About the Course
  2. Paper-1 & 2 | Basic Numeracy: Ratio and Proportion (Ratios), Divisibility Rules, Mixture and Alligation, Permutation and Combination, Logarithm, Number System, HCF LCM, Sequence and Series (Series), Speed Time and Distance, Percentage, Average, Mensuration and Geometry, Age Problems, Arithmetic, Statistics, Probability, Profit and Loss, Simple Interest and Compound Interest, Partnership, Speed Mathematics and Basic Mathematics, Algebra, Powers and Exponents (Surds and Indices), Time and Work, Pipe and Cistern, RSSB Specific Videos - Basic Numeracy
  3. Paper-1 & 2 | Data Interpretation: Data Interpretation
  4. Paper-1 & 2 | General Mental Ability: Mental Ability, RSSB Specific Videos - Mental Ability
  5. Paper-1 & 2 | Logical Reasoning and Analytical Ability: Series (Number and Letter Series) (Numerical Relations and Reasoning), Coding Decoding, Data Sufficiency, Non Verbal Reasoning (Spatial Aptitude) (Spatial Reasoning) (Visual Reasoning), Syllogisms, Seating Arrangements, Blood Relations, Directions (Direction Test), Analytical Reasoning (Counting Figures Reasoning), Puzzle Solving (Puzzles), Calendar, Clock, Cubes & Dices, Venn Diagram, Analogy, Ranking, Order and Sequence, Deductive and Inductive Reasoning (Logical Deduction and Induction) (Prepositional Reasoning), Data Arrangement, Logical Sequence Of Words, Crypt Arithmetic
  6. Paper-1 & 2 | Decision Making and Problem Solving: Selection Decision Table (Decision Making)
  7. Paper-1 | General Science: Physics, Biology, Chemistry, RSSB Specific Videos
  8. Paper-1 | General Awareness: State Wise GK, GK- Current Affairs
  9. Paper - 2 | Digital Logic Systems: Digital Systems & Boolean Basics, Logic Gates & Hardware, Combinational Circuit, Sequential Circuits
  10. Paper-2 | Database Management System: Basics of DBMS, ER Diagram, Relational Model & Functional Dependencies, Keys & Integrity Constraints, Normalization (1NF - BCNF), Decomposition Properties & 4NF, Relational Calculus, Relational Algebra, SQL, NoSQL
  11. Paper-2 | Data Structures & Algorithms: Introduction to DS, Array, Stack, Queue, Linked List, Tree, Graphs, Algorithm Analysis, Sorting Algorithms, Intro to Compilers, Hashing
  12. Paper 2 | Data Communication and Network Security: Introduction to CN, Data Communication, Data Link Layer - Ethernet, DLL: Error Control, Net Layer: IPv4 & Proto, Net Layer: IP Addressing, Application Layer, Hardware basics, Network Security, Ethical Hacking
  13. Paper-2 | Operating Systems: Introduction to OS, Process Management, Memory Management, File Management, Deadlock
  14. Paper-2 | Computer Organization and Architecture: Basics of COA, Floating Point Rep, Cache Memory Organization, Input Output Organisation, Instr Formats & Modes, Control Unit Design, Register Transfer and Microoperations, Programming the Basic Computer, Number System, Number Representation
  15. Paper 2 | System Analysis and Design: Fundamentals of Systems and Information Systems, Fundamentals of Software Engineering, SDLC and Development Approaches, Software Documentation and Software Requirements Specification (SRS), SDD and Quality Assurance, Security, Risk Management & Maintenance, Software Testing
  16. Paper-2 | C Programming: C Fundamentals, Control Flow, Functions, Arrays & Pointers, Storage Classes, Structures & Enums, DMA, Macros, Scoping & File Handling
  17. Paper 2 | OOPS , C++ , JAVA: Language Design, OOPS with C++, Java, .Net Programming, Java Fundamentals
  18. Paper 2 | Python: Introduction to Python, Tokens, Variables, Data Types, I/O, Operators & Expressions, Control Flow & Looping, Collections & Strings, Functions & Modules, File Handling & Data Analysis
  19. Emerging Trends and AI: Emerging Tech Trends, Artificial Intelligence
  20. Paper-2 | Data Processing (Ms-Office): MS Office Applications
  21. Paper-2 | Internet and Web Technologies: HTML Basics, CSS, XML, JavaScript-Basics, Internet Fundamentals, Protocols & Services, Web Publishing & Hosting, Server Side & Security, Emerging Technologies, Terms & Abbreviations, Cyber Threats and Malware Attacks, Role of Internet and Web Services, Security in Mobile and Wireless Computing
  22. Paper 2 | Pedagogy: Child Development, Theories, Concept of Pedagogy, Inclusive Education, Experiential Pedagogy, Assessment & Evaluation, Psychology, Curriculum Framework & Reforms, National Education Policy (NEP) 2020
  23. Live Classes: RSSB Live Sessions
  24. Paper 1 - Full Mock Tests:
  25. Paper 2 - Full Mock Tests:
  26. BCI Previous Year Papers:
AI summary & chapters

AI Summary

An AI-generated summary of this video lecture.

This educational video provides a detailed walkthrough of 'The Process of Documentation' within a Software Engineering context. The instructor guides students through a PDF document, highlighting key phases such as the collection of source material, the creation of a documentation plan, and the subsequent steps of review, creation, testing, and maintenance. Through a combination of on-screen text and handwritten annotations, the lecture emphasizes the importance of acquiring specifications, defining the target audience, and ensuring documents remain up-to-date with software versions.

Chapters

  1. 0:00 – 2:00 00:00-02:00

    The session begins with the 'Collection of source material' section. The instructor explains that the first step is acquiring required source material, including specifications, formats, screen layouts, and report layouts. She writes 'System specifications', 'Standard format', 'Layout', and 'Report page' on the left side of the screen. On the right, she draws a document icon, noting that a copy of the operational software is helpful for preparing user documentation. The text explicitly states that material is collected to aid in the preparation of the document.

  2. 2:00 – 5:00 02:00-05:00

    The instructor moves to the 'Documentation Plan' section. The text states the documenter is responsible for preparing a plan that specifies work details and defines the target audience. She writes 'planning' and 'document generator' on the board, mentioning 'CASE' tools. She begins drawing a flowchart on the right, starting with 'Acquire source material' and 'Planning documentation'. She also writes 'Document -> usability' to connect the creation phase with the testing phase, highlighting the iterative nature of the process.

  3. 5:00 – 7:56 05:00-07:56

    The final segment covers 'Review of Plan', 'Creation of Document', 'Testing of Document', and 'Maintain Document'. The PDF text explains that the plan is reviewed for correctness and completeness. The document is created with a generator and tested for usability. The instructor highlights that maintenance ensures the document is kept up to date with new software versions. She completes the flowchart with 'Reproduce and distribute document' and 'Maintain the document', circling page numbers '14' and '12' on her drawing to illustrate the physical structure of the document.

The lecture provides a comprehensive overview of the documentation lifecycle, starting with material collection and planning. It stresses the documenter's role in defining the audience and using tools like CASE. The process concludes with testing for usability and maintaining the document alongside software updates, ensuring the final output remains accurate and useful for the target audience throughout the software's life. The visual aids, including the flowchart and handwritten notes, reinforce the structured approach required for effective software documentation.

Loading lesson…