Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases now! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
The Complete Edition - Software Engineering for Real-Time Systems

You're reading from   The Complete Edition - Software Engineering for Real-Time Systems A software engineering perspective toward designing real-time systems

Arrow left icon
Product type Paperback
Published in Dec 2019
Publisher
ISBN-13 9781839216589
Length 824 pages
Edition 1st Edition
Languages
Arrow right icon
Author (1):
Arrow left icon
Jim Cooling Jim Cooling
Author Profile Icon Jim Cooling
Jim Cooling
Arrow right icon
View More author details
Toc

Table of Contents (16) Chapters Close

Preface
1. Real-Time Systems – Setting the Scene 2. The Search for Dependable Software FREE CHAPTER 3. First Steps – Requirements Analysis and Specification 4. Software and Program Design Concepts 5. Multitasking Systems – an Introduction 6. Diagramming – an Introduction 7. Practical Diagramming Methods 8. Designing and Constructing Software – Code-Related Issues 9. Software Analysis and Design – Methods and Methodologies 10. Analyzing and Testing Source Code 11. Development Tools 12. Mission-Critical and Safety-Critical Systems 13. Performance Engineering 14. Documentation Glossary of terms

14.1 Documentation – What and Why?

14.1.1 The Role of Documentation

What precisely is the role of documentation in design engineering? Fundamentally, it has three objectives: defining, communicating, and recording information.

In the first instance, a prospective customer must define what he wants, why he wants it, when it's needed, and, ultimately, how much he's prepared to pay. Likewise, the supplier needs to define what he intends to do, how he intends to do it, what the delivered product will do, and when it will be delivered. Later, many other points need elaborating and defining, ranging from performance aspects to maintenance features. These definition aspects basically determine the contents of engineering documents.

The second aspect, communication, is self-explanatory. But this has an impact on the style of presentation. To be really useful, documents need to communicate information effectively. Text is not an especially good medium, as engineers...

lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at €18.99/month. Cancel anytime