Procedures are a form of software documentation that provide step-by-step guidance to users on how to complete tasks. Effective procedures (1) introduce the task and its purpose, (2) provide all necessary information in a logical order, and (3) include elaboration to help users avoid mistakes and learn efficient techniques. Procedures should balance explanatory text, visual elements like screenshots, and interactive elements like embedded help to clearly guide users without overwhelming them. The level of detail in a procedure depends on the intended users' experience levels and task complexity.
Technical Communication
ENG 316
Instructions
*
Welcome to Technical Communications.
In this lesson we will discuss instructions.
Next slide.
Topics Definition and audiencePlanning instructionsOrganizing instructionsFormatting instructionsComposing instructionsField TestingOnline instructions
*
The following topics will be covered in this lesson:
Audience;
Planning instructions;
Organizing instructions;
Formatting instructions;
Composing instructions;
Field Testing; and
Online instructions.
Next slide.
Definition and AudienceInstructionsSequence of steps to complete a taskRequire accurate and precise informationInclude information based on audience knowledgeHelp readers comprehend steps and stay motivated
Instructions are the sequence of steps that explain how to complete a task. Those people who require instructions need to perform a task or understand how someone else performs the task. The audience for instructions follows the steps very carefully and requires accurate and precise information that is placed in the proper sequence.
The amount of detail provided in instructions depends on how much knowledge the audience has about the process. Well written instructions help the audience read carefully, stay motivated, and continue reading.
Next slide.
*
Planning InstructionsCreate a flowchart of stepsUnderstand the ultimate purposeWatch an audience member perform tasksTake note of difficult steps
When planning instructions, a writer should understand the procedure that is about to be detailed. Whenever possible, a writer should personally work through the process to understand any potential hurdles or confusion that eventual readers may face. The following steps should be used to plan instructions:
One. Create a flowchart with the process steps in order of execution.
Two. In your mind, think through the process backwards. What is the ultimate purpose of the procedure?
Three. Watch a member of the target audience performing the task for the first time and take notes regarding the first step and any difficult steps. Question the steps that the person misunderstands and interview the person after the procedure is completed to receive any suggestions.
Next slide.
*
Organizing InstructionsCautionDefinitionsLess explanationMore explanationWarningGraphicsIntroductionMaterials and toolsNotes and tips
After analyzing the information needed in the instructions, the steps should be organized into sections. It is then necessary to place the information into chronological steps and an easy-to-read format.
Some, but not all, instructions require an introduction or a list of materials. Elements that a writer can add to instructions include cautions, definitions, less explanation, more explanation, graphics, an introduction, materials and tools, notes and tips, and warnings. A caution is a statement that indicates actions that might harm the mechanism. Definitions are term explanations. A list of more than six definit ...
“Markets are certainly looking at election results with some apprehension, but what is also true is that they are in for a correction. Elections might act as the trigger for such a correction,” said Jagannadham Thunuguntla, equity head at SMC Capitals.
From Use to User Interface- This 3-4 hour tutorial describes a practical approach to translating the goals users would like to achieve and the tasks they wish to accomplish into user interface designs that effectively support those goals and tasks.
Technical Communication
ENG 316
Instructions
*
Welcome to Technical Communications.
In this lesson we will discuss instructions.
Next slide.
Topics Definition and audiencePlanning instructionsOrganizing instructionsFormatting instructionsComposing instructionsField TestingOnline instructions
*
The following topics will be covered in this lesson:
Audience;
Planning instructions;
Organizing instructions;
Formatting instructions;
Composing instructions;
Field Testing; and
Online instructions.
Next slide.
Definition and AudienceInstructionsSequence of steps to complete a taskRequire accurate and precise informationInclude information based on audience knowledgeHelp readers comprehend steps and stay motivated
Instructions are the sequence of steps that explain how to complete a task. Those people who require instructions need to perform a task or understand how someone else performs the task. The audience for instructions follows the steps very carefully and requires accurate and precise information that is placed in the proper sequence.
The amount of detail provided in instructions depends on how much knowledge the audience has about the process. Well written instructions help the audience read carefully, stay motivated, and continue reading.
Next slide.
*
Planning InstructionsCreate a flowchart of stepsUnderstand the ultimate purposeWatch an audience member perform tasksTake note of difficult steps
When planning instructions, a writer should understand the procedure that is about to be detailed. Whenever possible, a writer should personally work through the process to understand any potential hurdles or confusion that eventual readers may face. The following steps should be used to plan instructions:
One. Create a flowchart with the process steps in order of execution.
Two. In your mind, think through the process backwards. What is the ultimate purpose of the procedure?
Three. Watch a member of the target audience performing the task for the first time and take notes regarding the first step and any difficult steps. Question the steps that the person misunderstands and interview the person after the procedure is completed to receive any suggestions.
Next slide.
*
Organizing InstructionsCautionDefinitionsLess explanationMore explanationWarningGraphicsIntroductionMaterials and toolsNotes and tips
After analyzing the information needed in the instructions, the steps should be organized into sections. It is then necessary to place the information into chronological steps and an easy-to-read format.
Some, but not all, instructions require an introduction or a list of materials. Elements that a writer can add to instructions include cautions, definitions, less explanation, more explanation, graphics, an introduction, materials and tools, notes and tips, and warnings. A caution is a statement that indicates actions that might harm the mechanism. Definitions are term explanations. A list of more than six definit ...
“Markets are certainly looking at election results with some apprehension, but what is also true is that they are in for a correction. Elections might act as the trigger for such a correction,” said Jagannadham Thunuguntla, equity head at SMC Capitals.
From Use to User Interface- This 3-4 hour tutorial describes a practical approach to translating the goals users would like to achieve and the tasks they wish to accomplish into user interface designs that effectively support those goals and tasks.
Principles of Health Informatics: Usability of medical softwareMartin Chapman
Principles of Health Informatics: Usability of medical software. Last delivered in 2023. All educational material listed or linked to on these pages in relation to King's College London may be provided for reference only, and therefore does not necessarily reflect the current course content.
Management Information System UX Case studyAchin Gupta
We got the requirement for re-designing the Management Information System for our organization as many employees was facing the problem in the system related to usability and interaction of the system with users.
We initiate with different research methods like Heuristic evaluation, Interviews, Surveys, Competitive analysis to find out the problem objectives of the system and from those objectives, we started working on the improvements of User Experience, System Interaction and User Interface to make User-Centric Design.
We also did the usability testing on the final design and made some iterations from the users' feedback.
To find out the problem objectives we need to empathise with the users to get to know what they are feeling while using the current system. For that we categorised our research into two
parts - Primary Research and Secondary Research.
In Primary Research, We anaylised the users by taking interviews, prepared questionnaires, Direct observation and Heuristic Evaluation of the present design which helps us to find out the bottle neck areas of the system.
From Secondary Research, We were able to analyse the challenges faced by different types of users and the what are the technological challenges are there which affecting the tasks
performed by users in the system.
Chapter 11: User support
from
Dix, Finlay, Abowd and Beale (2004).
Human-Computer Interaction, third edition.
Prentice Hall. ISBN 0-13-239864-8.
http://www.hcibook.com/e3/
SoftCloud: A Tool for Visualizing Software Artifacts as Tag Clouds.pdfRa'Fat Al-Msie'deen
Software artifacts visualization helps software developers to manage the size and complexity of the software system. The tag cloud technique visualizes tags within the cloud according to their frequencies in software artifacts. A font size of the tag within the cloud indicates its frequency within a software artifact, while the color of a tag within the cloud uses just for aesthetic purposes. This paper suggests a new approach (SoftCloud) to visualize software artifacts as a tag cloud. The originality of SoftCloud is visualizing all the artifacts available to the software program as a tag cloud. Experiments have conducted on different software artifacts to validate SoftCloud and demonstrate its strengths. The results showed the ability of SoftCloud to correctly retrieve all tags and their frequencies from available software artifacts.
BushraDBR: An Automatic Approach to Retrieving Duplicate Bug Reports.pdfRa'Fat Al-Msie'deen
A Bug Tracking System (BTS), such as Bugzilla, is generally utilized to track submitted Bug Reports (BRs) for a particular software system. Duplicate Bug Report (DBR) retrieval is the process of obtaining a DBR in the BTS. This process is important to avoid needless work from engineers on DBRs. To prevent wasting engineer resources, such as effort and time, on previously submitted (or duplicate) BRs, it is essential to find and retrieve DBRs as soon as they are submitted by software users. Thus, this paper proposes an automatic approach (called BushraDBR) that aims to assist an engineer (called a triager) to retrieve DBRs and stop the duplicates before they start. Where BushraDBR stands for Bushra Duplicate Bug Reports retrieval process. Therefore, when a new BR is sent to the Bug Repository (BRE), an engineer checks whether it is a duplicate of an existing BR in BRE or not via BushraDBR approach. If it is, the engineer marks it as DBR, and the BR is excluded from consideration for any additional work; otherwise, the BR is added to the BRE. BushraDBR approach relies on Textual Similarity (TS) between the newly submitted BR and the rest of the BRs in BRE to retrieve DBRs. BushraDBR exploits unstructured data from BRs to apply Information Retrieval (IR) methods in an efficient way. BushraDBR approach uses two techniques to retrieve DBRs: Latent Semantic Indexing (LSI) and Formal Concept Analysis (FCA). The originality of BushraDBR is to stop DBRs before they occur by comparing the newly reported BR with the rest of the BRs in the BTS, thus saving time and effort during the Software Maintenance (SM) process. BushraDBR also uniquely retrieves DBR through the use of LSI and FCA techniques. BushraDBR approach had been validated and evaluated on several publicly available data sets from Bugzilla. Experiments show the ability of BushraDBR approach to retrieve DBRs in an efficient and accurate manner.
More Related Content
Similar to Software Documentation "writing to guide- procedures"
Principles of Health Informatics: Usability of medical softwareMartin Chapman
Principles of Health Informatics: Usability of medical software. Last delivered in 2023. All educational material listed or linked to on these pages in relation to King's College London may be provided for reference only, and therefore does not necessarily reflect the current course content.
Management Information System UX Case studyAchin Gupta
We got the requirement for re-designing the Management Information System for our organization as many employees was facing the problem in the system related to usability and interaction of the system with users.
We initiate with different research methods like Heuristic evaluation, Interviews, Surveys, Competitive analysis to find out the problem objectives of the system and from those objectives, we started working on the improvements of User Experience, System Interaction and User Interface to make User-Centric Design.
We also did the usability testing on the final design and made some iterations from the users' feedback.
To find out the problem objectives we need to empathise with the users to get to know what they are feeling while using the current system. For that we categorised our research into two
parts - Primary Research and Secondary Research.
In Primary Research, We anaylised the users by taking interviews, prepared questionnaires, Direct observation and Heuristic Evaluation of the present design which helps us to find out the bottle neck areas of the system.
From Secondary Research, We were able to analyse the challenges faced by different types of users and the what are the technological challenges are there which affecting the tasks
performed by users in the system.
Chapter 11: User support
from
Dix, Finlay, Abowd and Beale (2004).
Human-Computer Interaction, third edition.
Prentice Hall. ISBN 0-13-239864-8.
http://www.hcibook.com/e3/
SoftCloud: A Tool for Visualizing Software Artifacts as Tag Clouds.pdfRa'Fat Al-Msie'deen
Software artifacts visualization helps software developers to manage the size and complexity of the software system. The tag cloud technique visualizes tags within the cloud according to their frequencies in software artifacts. A font size of the tag within the cloud indicates its frequency within a software artifact, while the color of a tag within the cloud uses just for aesthetic purposes. This paper suggests a new approach (SoftCloud) to visualize software artifacts as a tag cloud. The originality of SoftCloud is visualizing all the artifacts available to the software program as a tag cloud. Experiments have conducted on different software artifacts to validate SoftCloud and demonstrate its strengths. The results showed the ability of SoftCloud to correctly retrieve all tags and their frequencies from available software artifacts.
BushraDBR: An Automatic Approach to Retrieving Duplicate Bug Reports.pdfRa'Fat Al-Msie'deen
A Bug Tracking System (BTS), such as Bugzilla, is generally utilized to track submitted Bug Reports (BRs) for a particular software system. Duplicate Bug Report (DBR) retrieval is the process of obtaining a DBR in the BTS. This process is important to avoid needless work from engineers on DBRs. To prevent wasting engineer resources, such as effort and time, on previously submitted (or duplicate) BRs, it is essential to find and retrieve DBRs as soon as they are submitted by software users. Thus, this paper proposes an automatic approach (called BushraDBR) that aims to assist an engineer (called a triager) to retrieve DBRs and stop the duplicates before they start. Where BushraDBR stands for Bushra Duplicate Bug Reports retrieval process. Therefore, when a new BR is sent to the Bug Repository (BRE), an engineer checks whether it is a duplicate of an existing BR in BRE or not via BushraDBR approach. If it is, the engineer marks it as DBR, and the BR is excluded from consideration for any additional work; otherwise, the BR is added to the BRE. BushraDBR approach relies on Textual Similarity (TS) between the newly submitted BR and the rest of the BRs in BRE to retrieve DBRs. BushraDBR exploits unstructured data from BRs to apply Information Retrieval (IR) methods in an efficient way. BushraDBR approach uses two techniques to retrieve DBRs: Latent Semantic Indexing (LSI) and Formal Concept Analysis (FCA). The originality of BushraDBR is to stop DBRs before they occur by comparing the newly reported BR with the rest of the BRs in the BTS, thus saving time and effort during the Software Maintenance (SM) process. BushraDBR also uniquely retrieves DBR through the use of LSI and FCA techniques. BushraDBR approach had been validated and evaluated on several publicly available data sets from Bugzilla. Experiments show the ability of BushraDBR approach to retrieve DBRs in an efficient and accurate manner.
Software evolution understanding: Automatic extraction of software identifier...Ra'Fat Al-Msie'deen
Software companies usually develop a set of product variants within the same family that share certain functions and differ in others. Variations across software variants occur to meet different customer requirements. Thus, software product variants evolve overtime to cope with new requirements. A software engineer who deals with this family may find it difficult to understand the evolution scenarios that have taken place over time. In addition, software identifier names are important resources to understand the evolution scenarios in this family. This paper introduces an automatic approach called Juana’s approach to detect the evolution scenario across two product variants at the source code level and identifies the common and unique software identifier names across software variants source code. Juana’s approach refers to common and unique identifier names as a software identifiers map and computes it by comparing software variants to each other. Juana considers all software identifier names such as package, class, attribute, and method. The novelty of this approach is that it exploits common and unique identifier names across the source code of software variants, to understand the evolution scenarios across software family in an efficient way. For validity, Juana was applied on ArgoUML and Mobile Media software variants. The results of this evaluation validate the relevance and the performance of the approach as all evolution scenarios were correctly detected via a software identifiers map.
BushraDBR: An Automatic Approach to Retrieving Duplicate Bug ReportsRa'Fat Al-Msie'deen
A Bug Tracking System (BTS), such as Bugzilla, is generally utilized to track submitted Bug Reports (BRs) for a particular software system. Duplicate Bug Report (DBR) retrieval is the process of obtaining a DBR in the BTS. This process is important to avoid needless work from engineers on DBRs. To prevent wasting engineer resources, such as effort and time, on previously submitted (or duplicate) BRs, it is essential to find and retrieve DBRs as soon as they are submitted by software users. Thus, this paper proposes an automatic approach (called BushraDBR) that aims to assist an engineer (called a triager) to retrieve DBRs and stop the duplicates before they start. Where BushraDBR stands for Bushra Duplicate Bug Reports retrieval process. Therefore, when a new BR is sent to the Bug Repository (BRE), an engineer checks whether it is a duplicate of an existing BR in BRE or not via BushraDBR approach. If it is, the engineer marks it as DBR, and the BR is excluded from consideration for any additional work; otherwise, the BR is added to the BRE. BushraDBR approach relies on Textual Similarity (TS) between the newly submitted BR and the rest of the BRs in BRE to retrieve DBRs. BushraDBR exploits unstructured data from BRs to apply Information Retrieval (IR) methods in an efficient way. BushraDBR approach uses two techniques to retrieve DBRs: Latent Semantic Indexing (LSI) and Formal Concept Analysis (FCA). The originality of BushraDBR is to stop DBRs before they occur by comparing the newly reported BR with the rest of the BRs in the BTS, thus saving time and effort during the Software Maintenance (SM) process. BushraDBR also uniquely retrieves DBR through the use of LSI and FCA techniques. BushraDBR approach had been validated and evaluated on several publicly available data sets from Bugzilla. Experiments show the ability of BushraDBR approach to retrieve DBRs in an efficient and accurate manner.
Source code summarization is a process of generating summaries that describes software code, the majority of source code summarization usually generated manually, where the summaries are written by software developers. Recently, new automated approaches are becoming more useful. These approaches have been found to be effective in some cases. The main weaknesses of these approaches are that they never exploit code dependencies and summarize either the software classes or methods but not both. This paper proposes a source code summarization approach (Suncode) that produces a short description for each class and method in the software system. To validate the approach, it has been applied on several case studies. Moreover, the generated summaries are compared to summaries that written by human experts and to summaries that written by a state-of-the-art solution. Results of this paper found that Suncode summaries provide better information about code dependencies comparing with other studies. In addition, Suncode summaries can improve and support the current software documentation. The results found that manually written summaries were more precise and short as well.
FeatureClouds: Naming the Identified Feature Implementation Blocks from Softw...Ra'Fat Al-Msie'deen
Identifying software identifiers that implement a particular feature of a software product is known as feature identification. Feature identification is one of the most critical and popular processes performed by software engineers during software maintenance activity. However, a meaningful name must be assigned to the Identified Feature Implementation Block (IFIB) to complete the feature identification process. The feature naming process remains a challenging task, where the majority of existing approaches manually assign the name of the IFIB. In this paper, the approach called FeatureClouds was proposed, which can be exploited by software developers to name the IFIBs from software code. FeatureClouds approach incorporates word clouds visualization technique to name Feature Blocks (FBs) by using the most frequent words across these blocks. FeatureClouds had evaluated by assessing its added benefit to the current approaches in the literature, where limited tool support was supplied to software developers to distinguish feature names of the IFIBs. For validity, FeatureClouds had applied to draw shapes and ArgoUML software. The findings showed that the proposed approach achieved promising results according to well-known metrics in terms of Precision and Recall.
YamenTrace: Requirements Traceability - Recovering and Visualizing Traceabili...Ra'Fat Al-Msie'deen
YamenTrace - Requirements Traceability: Recovering and Visualizing Traceability Links Between Requirements and Source Code of Object-oriented Software Systems (Presentation 2023)
Automatic Labeling of the Object-oriented Source Code: The Lotus ApproachRa'Fat Al-Msie'deen
Most of open-source software systems become available on the internet today. Thus, we need automatic methods to label software code. Software code can be labeled with a set of keywords. These keywords in this paper referred as software labels. The goal of this paper is to provide a quick view of the software code vocabulary. This paper proposes an automatic approach to document the object-oriented software by labeling its code. The approach exploits all software identifiers to label software code. The paper presents the results of study conducted on the ArgoUML and drawing shapes case studies. Results showed that all code labels were correctly identified.
Constructing a software requirements specification and design for electronic ...Ra'Fat Al-Msie'deen
Requirements engineering process intends to obtain software services and constraints. This process is essential to meet the customer's needs and expectations. This process includes three main activities in general. These are detecting requirements by interacting with software stakeholders, transferring these requirements into a standard document, and examining that the requirements really define the software that the client needs. Functional requirements are services that the software should deliver to the end-user. In addition, functional requirements describe how the software should respond to specific inputs, and how the software should behave in certain circumstances. This paper aims to develop a software requirements specification document of the electronic IT news magazine system. The electronic magazine provides users to post and view up-to-date IT news. Still, there is a lack in the literature of comprehensive studies about the construction of the electronic magazine software specification and design in conformance with the contemporary software development processes. Moreover, there is a need for a suitable research framework to support the requirements engineering process. The novelty of this paper is the construction of software specification and design of the electronic magazine by following the Al-Msie'deen research framework. All the documents of software requirements specification and design have been constructed to conform to the agile usage-centered design technique and the proposed research framework. A requirements specification and design are suggested and followed for the construction of the electronic magazine software. This study proved that involving users extensively in the process of software requirements specification and design will lead to the creation of dependable and acceptable software systems.
Detecting commonality and variability in use-case diagram variantsRa'Fat Al-Msie'deen
The use-case diagram is a software artifact. Thus, as with any software artifact, the use-case diagrams change across time through the software development life cycle. Therefore, several versions of the same diagram are existed at distinct times. Thus, comparing all use-case diagram variants to detect common and variable use-cases becomes one of the main challenges in the product line reengineering field. The contribution of this paper is to suggest an automatic approach to compare a collection of use-case diagram variants and detect both commonality and variability. In our work, every use-case represents a feature. The proposed approach visualizes the detected features using formal concept analysis, where common and variable features are introduced to software engineers. The proposed approach was applied on a mobile media case study to be validated. The findings confirm the importance and the performance of the suggested approach as all common and variable features were precisely detected via formal concept analysis and latent semantic indexing.
Naming the Identified Feature Implementation Blocks from Software Source CodeRa'Fat Al-Msie'deen
Identifying software identifiers that implement a particular feature of a software product is known as feature identification. Feature identification is one of the most critical and popular processes performed by software engineers during software maintenance activity. However, a meaningful name must be assigned to the Identified Feature Implementation Block (IFIB) to complete the feature identification process. The feature naming process remains a challenging task, where the majority of existing approaches manually assign the name of the IFIB. In this paper, the approach called FeatureClouds was proposed, which can be exploited by software developers to name the IFIBs from software code. FeatureClouds approach incorporates word clouds visualization technique to name Feature Blocks (FBs) by using the most frequent words across these blocks. FeatureClouds had evaluated by assessing its added benefit to the current approaches in the literature, where limited tool support was supplied to software developers to distinguish feature names of the IFIBs. For validity, FeatureClouds had applied to draw shapes and ArgoUML software. The findings showed that the proposed approach achieved promising results according to well-known metrics in terms of Precision and Recall.
Safalta Digital marketing institute in Noida, provide complete applications that encompass a huge range of virtual advertising and marketing additives, which includes search engine optimization, virtual communication advertising, pay-per-click on marketing, content material advertising, internet analytics, and greater. These university courses are designed for students who possess a comprehensive understanding of virtual marketing strategies and attributes.Safalta Digital Marketing Institute in Noida is a first choice for young individuals or students who are looking to start their careers in the field of digital advertising. The institute gives specialized courses designed and certification.
for beginners, providing thorough training in areas such as SEO, digital communication marketing, and PPC training in Noida. After finishing the program, students receive the certifications recognised by top different universitie, setting a strong foundation for a successful career in digital marketing.
A Strategic Approach: GenAI in EducationPeter Windle
Artificial Intelligence (AI) technologies such as Generative AI, Image Generators and Large Language Models have had a dramatic impact on teaching, learning and assessment over the past 18 months. The most immediate threat AI posed was to Academic Integrity with Higher Education Institutes (HEIs) focusing their efforts on combating the use of GenAI in assessment. Guidelines were developed for staff and students, policies put in place too. Innovative educators have forged paths in the use of Generative AI for teaching, learning and assessments leading to pockets of transformation springing up across HEIs, often with little or no top-down guidance, support or direction.
This Gasta posits a strategic approach to integrating AI into HEIs to prepare staff, students and the curriculum for an evolving world and workplace. We will highlight the advantages of working with these technologies beyond the realm of teaching, learning and assessment by considering prompt engineering skills, industry impact, curriculum changes, and the need for staff upskilling. In contrast, not engaging strategically with Generative AI poses risks, including falling behind peers, missed opportunities and failing to ensure our graduates remain employable. The rapid evolution of AI technologies necessitates a proactive and strategic approach if we are to remain relevant.
Introduction to AI for Nonprofits with Tapp NetworkTechSoup
Dive into the world of AI! Experts Jon Hill and Tareq Monaur will guide you through AI's role in enhancing nonprofit websites and basic marketing strategies, making it easy to understand and apply.
This slide is special for master students (MIBS & MIFB) in UUM. Also useful for readers who are interested in the topic of contemporary Islamic banking.
Executive Directors Chat Leveraging AI for Diversity, Equity, and InclusionTechSoup
Let’s explore the intersection of technology and equity in the final session of our DEI series. Discover how AI tools, like ChatGPT, can be used to support and enhance your nonprofit's DEI initiatives. Participants will gain insights into practical AI applications and get tips for leveraging technology to advance their DEI goals.
Exploiting Artificial Intelligence for Empowering Researchers and Faculty, In...Dr. Vinod Kumar Kanvaria
Exploiting Artificial Intelligence for Empowering Researchers and Faculty,
International FDP on Fundamentals of Research in Social Sciences
at Integral University, Lucknow, 06.06.2024
By Dr. Vinod Kumar Kanvaria
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...Levi Shapiro
Letter from the Congress of the United States regarding Anti-Semitism sent June 3rd to MIT President Sally Kornbluth, MIT Corp Chair, Mark Gorenberg
Dear Dr. Kornbluth and Mr. Gorenberg,
The US House of Representatives is deeply concerned by ongoing and pervasive acts of antisemitic
harassment and intimidation at the Massachusetts Institute of Technology (MIT). Failing to act decisively to ensure a safe learning environment for all students would be a grave dereliction of your responsibilities as President of MIT and Chair of the MIT Corporation.
This Congress will not stand idly by and allow an environment hostile to Jewish students to persist. The House believes that your institution is in violation of Title VI of the Civil Rights Act, and the inability or
unwillingness to rectify this violation through action requires accountability.
Postsecondary education is a unique opportunity for students to learn and have their ideas and beliefs challenged. However, universities receiving hundreds of millions of federal funds annually have denied
students that opportunity and have been hijacked to become venues for the promotion of terrorism, antisemitic harassment and intimidation, unlawful encampments, and in some cases, assaults and riots.
The House of Representatives will not countenance the use of federal funds to indoctrinate students into hateful, antisemitic, anti-American supporters of terrorism. Investigations into campus antisemitism by the Committee on Education and the Workforce and the Committee on Ways and Means have been expanded into a Congress-wide probe across all relevant jurisdictions to address this national crisis. The undersigned Committees will conduct oversight into the use of federal funds at MIT and its learning environment under authorities granted to each Committee.
• The Committee on Education and the Workforce has been investigating your institution since December 7, 2023. The Committee has broad jurisdiction over postsecondary education, including its compliance with Title VI of the Civil Rights Act, campus safety concerns over disruptions to the learning environment, and the awarding of federal student aid under the Higher Education Act.
• The Committee on Oversight and Accountability is investigating the sources of funding and other support flowing to groups espousing pro-Hamas propaganda and engaged in antisemitic harassment and intimidation of students. The Committee on Oversight and Accountability is the principal oversight committee of the US House of Representatives and has broad authority to investigate “any matter” at “any time” under House Rule X.
• The Committee on Ways and Means has been investigating several universities since November 15, 2023, when the Committee held a hearing entitled From Ivory Towers to Dark Corners: Investigating the Nexus Between Antisemitism, Tax-Exempt Universities, and Terror Financing. The Committee followed the hearing with letters to those institutions on January 10, 202
Francesca Gottschalk - How can education support child empowerment.pptxEduSkills OECD
Francesca Gottschalk from the OECD’s Centre for Educational Research and Innovation presents at the Ask an Expert Webinar: How can education support child empowerment?
Operation “Blue Star” is the only event in the history of Independent India where the state went into war with its own people. Even after about 40 years it is not clear if it was culmination of states anger over people of the region, a political game of power or start of dictatorial chapter in the democratic setup.
The people of Punjab felt alienated from main stream due to denial of their just demands during a long democratic struggle since independence. As it happen all over the word, it led to militant struggle with great loss of lives of military, police and civilian personnel. Killing of Indira Gandhi and massacre of innocent Sikhs in Delhi and other India cities was also associated with this movement.
Biological screening of herbal drugs: Introduction and Need for
Phyto-Pharmacological Screening, New Strategies for evaluating
Natural Products, In vitro evaluation techniques for Antioxidants, Antimicrobial and Anticancer drugs. In vivo evaluation techniques
for Anti-inflammatory, Antiulcer, Anticancer, Wound healing, Antidiabetic, Hepatoprotective, Cardio protective, Diuretics and
Antifertility, Toxicity studies as per OECD guidelines
Normal Labour/ Stages of Labour/ Mechanism of LabourWasim Ak
Normal labor is also termed spontaneous labor, defined as the natural physiological process through which the fetus, placenta, and membranes are expelled from the uterus through the birth canal at term (37 to 42 weeks
Normal Labour/ Stages of Labour/ Mechanism of Labour
Software Documentation "writing to guide- procedures"
1. “Writing to Teach- Tutorials”
“Writing to Guide- Procedures”
“Writing to Support- References”
Software Documentation
Mutah University
Faculty of IT, Department of Software Engineering
Dr. Ra’Fat A. AL-msie’deen
rafatalmsiedeen@mutah.edu.jo
https://rafat66.github.io/Al-Msie-Deen/
Part One
The Forms of Software Documentation
3. Topics covered
• Procedure
• Effective procedure
• Procedure tips
• Procedure Guidelines
• Appropriate instructional format of procedure
• What constitute a procedure?
• What kind of info user need guidance?
• How does a procedure work?
4. Procedure
• Guidance information, also known as step-by-step instruction or
procedures, makes up the heart of all task oriented documentation
system.
• Guidance means that the user forfeit a certain amount of control to
the manual in order to perform a discrete task, then he or she will
resumes control again.
• Procedures consist of how-to-do-it explanations, but also require
how-it-works and why-it-works overviews.
Our job is to balance these elements to meet user informational
needs and to make them efficient and effective in their
workplace.
5. Effective procedure
• Information you need to provide in an effective procedures:
1) Introduction emphasize creativity and user control of the program.
2) Screen shows the user result of actions.
3) Tips help the user find ways to use the program efficiently.
4) Tables help the user decide what options to exercise for this step.
5) Elaboration tells the result of actions and tells the user where to
get more information.
6. Procedure tips
Tips- when writing procedures:
a) Give readers the essential information - information that will help them
complete the procedure - first.
b) Limit the use of screen captures.
c) Make the steps as brief as possible.
d) Write in present tense.
e) Keep procedures as short as possible. If a procedure becomes extremely
long, see whether you can logically break it up into two shorter
procedures.
f) Reduce the number of decisions a reader has to make. If necessary, move
some decision points outside the process steps or redesign the software
interface for more consistency across platforms.
g) State conditionals clearly at the beginning of sentences or paragraphs, so
that readers can skip text that isn't relevant to them.
7. Procedure Guidelines
1. Relate the task to meaningful workplace activities:
A procedure is a step by step series of commands for accomplishing
a meaningful operation with a software program.
But what makes it meaningful does not reside in the operation itself.
When the user do install the software (procedure) they do this not
for the sake of installation, but to use the program to do other
workplace actions.
12. Procedure Guidelines … cont.
2. Determine how much information your user needs:
Depending on the task difficulty and the user experience the detail
of procedure will varies.
A rich procedure needs more visuals, more explanations, more
options, describe more results.
A sparse procedure on the other hand require only the repeating of
the steps in the task description.
13. Procedure Guidelines … cont.
2. Determine how much information your user needs:
o The step with a rich procedure will contain the following
explanations:
What happens when user takes the action.
“you will see… the program prompts you..”
Suggested response to the program state “we suggest that”.
Screens showing where to point the mouse.
Cautions and warnings.
Tips for efficient use.
Tables showing options and choices.
References to other sections of the manual.
14. Procedure Guidelines … cont.
3. Choose the appropriate instructional format:
A. Standard format, which contains steps, notes, screen shots, and other
elements left justified in one or two columns in a sequential order from
first to last.
Advantages of this format are its recognizability, its ease of flow from one
page to another, the ability to easily re-number tasks, and the easy to see
steps.
Some disadvantages are the space it may require and the potential to be
confusing if complex steps need to be mixed with simple steps.
15. Procedure Guidelines … cont.
3. Choose the appropriate instructional format:
B. Prose format, puts steps in sentences and paragraph forms making
it look and feel more conversational over Standard format's
command approach.
Advantages of prose are the relaxed tone, saves space, clarifies
simple, basic steps, accommodates experienced users.
Some disadvantages are steps buried in paragraphs, lengthy
explanation of individual steps, inability to accommodate graphics,
and the lack of support for novice users.
16. Procedure Guidelines … cont.
3. Choose the appropriate instructional format:
C. Parallel format, shows a screen with the fields empty and parallels the
field names in the steps that follow. This format is nice for programs with
complicated data fields of dialog boxes. Some keys to parallel format are
to keep terminology consistent, cue terms to the screen, discuss one
screen at a time, use plenty of examples, explain the format to the user.
Advantages of parallel format are the organizational benefits, great
for complicated screens and dialog boxes.
Disadvantages are it doesn't present the information in step by step
format, it can not be used for all procedures, it may confuse users, it
has to fit on one page.
17. Procedure Guidelines … cont.
3. Choose the appropriate instructional format:
D. Embedded help, is the name for "interactive assistance" found in
most programs today. Uses for embedded help are tips for effective
use (reminders of keyboard shortcuts or suggested file names), cue
cards (brief explanations of buttons and fields), short animated
descriptions, and trouble-shooting tips.
Embedded help can offer the following info:
1) Tips for efficient use.
2) Cue cards brief explanation of buttons and fields.
3) Short animated demo.
4) Trouble shooting tips.
22. Procedure Guidelines … cont.
4. Follow a rhythm of exposition,
Which means a pattern of steps, note, and illustration. Such as:
First I say what will happen.
Then I give the command for the first action.
Then I say how the program will respond.
Then I tell the next step.
The basic idea of rhythm of expositions lies in the action/response
pattern. Computer programs work in the way: take an action, the
system respond, and these events get repeated over and over again.
23. Procedure Guidelines … cont.
5. Test all procedures for accuracy,
Evaluative test, which means that after you finish the procedure,
you have an actual user, or prototype of the user, or yourself as a
last resort to perform the steps, so get ready to have your eyes
opened to all the conditions, alternatives, options, and other details
you left out.
24. What constitute a procedure?
• Procedures results directly from your thorough program task list,
putting the functions of the program into usable sets of steps that do
the user’s work.
• All procedural documentation answers the user’s simple question “
how do you use the program? As such, it functions on the guidance
level. The user need to know what key to press, what reports and
screen will look like, how to get out of trouble.
• The teaching as we have seen in tutorials try to get the user to
remember the lesson after the lesson finishes.
• Procedures and tutorials differ greatly, procedure focus on options
the user might take, whereas tutorials focus on only those keys and
actions needed to perform a specific task. A procedure expands the
user’s focus, a tutorial contracts it.
25. What constitute a procedure? … cont.
• Procedures and reference differs also, in guidance (procedures) the
documentation define the task its beginnings and endings, you do this
for a user to follow unfamiliar steps to perform a task he or she does
seldom or for the first time. In the support level (reference) the user
define the task and goes to the documentation to get an essential
info needed to perform the task.
26. What constitute a procedure? … cont.
What kind of info user need guidance?
• Installation because it varies from system to system user needed
guidance, maintaining and repairing systems.
• Finally the goal of the procedure should indicate what task it
performs; installing printer, retrieving a record.
27. What constitute a procedure? … cont.
How does a procedure work?
A procedure works, guide the user through a series of tasks to a
designated end, because you designed each of its parts to do a
specific job.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Task name, use performance oriented language such as
“opening a file” or “printing a card”.
28. What constitute a procedure? … cont.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Scenario, it means a small story or narrative in a setting, it tells
or reminds the user what the task will allow him or her to
accomplish in a working setting.
Scenario has a dual function of introducing the task and
suggesting workplace application.
Base the scenario on information you discovered while writing
your program task list and analyzing your user.
29. What constitute a procedure? … cont.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Steps, steps tell the user what to do, it tells the tools to use and
the action to take with the tool.
o“use the mouse to select”.
Often users does not read the explanation that go along with the
steps, so you should make the steps as self sufficient as possible.
30. What constitute a procedure? … cont.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Elaboration, with elaboration you share the following with your
user:
ꟷ Possible mistakes and how to avoid them.
ꟷ How to perform procedures efficiently.
ꟷ Alternatives such as keystrokes, toolbars.
ꟷ Definition of terms.
ꟷ Ways to tell if a step has been performed correctly.
ꟷ Where else to look for additional info.
31. What constitute a procedure? … cont.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Tables, follow these guideline when using tables:
Keep table simple.
Cite the table in the text.
Use descriptive, performance based column titles.
Use visual cues for keys or command, or menu selections
presented in tables.
32. What constitute a procedure? … cont.
The following discuss how each of those parts contribute to the
overall task orientation of the procedure:
Screens, use screen to the following:
ꟷ Show the partial result of a procedure.
ꟷ Show the final result of the procedure to let the user know
where the procedure ends.
ꟷ Show dialog box where the user has to make choices.
ꟷ Show toolbars indicating which tools the user need.
ꟷ Show menus indicating what command the user need.
35. “Writing to Teach- Tutorials”
“Writing to Guide- Procedures”
“Writing to Support- References”
Software Documentation
Mutah University
Faculty of IT, Department of Software Engineering
Dr. Ra’Fat A. AL-msie’deen
rafatalmsiedeen@mutah.edu.jo
https://rafat66.github.io/Al-Msie-Deen/
Part One
The Forms of Software Documentation