Download or read book Creating Effective Documentation for Computer Programs written by G. Prentice Hastings and published by Prentice Hall. This book was released on 1986 with total page 240 pages. Available in PDF, EPUB and Kindle. Book excerpt:
Download or read book Docs Like Code written by Anne Gentle and published by Lulu.com. This book was released on 2017-09-09 with total page 118 pages. Available in PDF, EPUB and Kindle. Book excerpt: Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyone's efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.
Download or read book Writing Software Documentation A Task Oriented Approach 2 E written by Barker and published by Pearson Education India. This book was released on 2003-09 with total page 500 pages. Available in PDF, EPUB and Kindle. Book excerpt:
Download or read book The Art of Technical Documentation written by Katherine Haramundanis and published by Digital Press. This book was released on 2014-05-16 with total page 287 pages. Available in PDF, EPUB and Kindle. Book excerpt: The Art of Technical Documentation presents concepts, techniques, and practices in order to produce effective technical documentation. The book provides the definition of technical documentation; qualities of a good technical documentation; career paths and documentation management styles; precepts of technical documentation; practices for gathering information, understanding what you have gathered, and methods for testing documentation; and considerations of information representation, to provide insights on how different representations affect reader perception of your documents. Technical writers and scientists will find the book a good reference material.
Download or read book Just Enough Software Architecture written by George Fairbanks and published by Marshall & Brainerd. This book was released on 2010-08-30 with total page 378 pages. Available in PDF, EPUB and Kindle. Book excerpt: This is a practical guide for software developers, and different than other software architecture books. Here's why: It teaches risk-driven architecting. There is no need for meticulous designs when risks are small, nor any excuse for sloppy designs when risks threaten your success. This book describes a way to do just enough architecture. It avoids the one-size-fits-all process tar pit with advice on how to tune your design effort based on the risks you face. It democratizes architecture. This book seeks to make architecture relevant to all software developers. Developers need to understand how to use constraints as guiderails that ensure desired outcomes, and how seemingly small changes can affect a system's properties. It cultivates declarative knowledge. There is a difference between being able to hit a ball and knowing why you are able to hit it, what psychologists refer to as procedural knowledge versus declarative knowledge. This book will make you more aware of what you have been doing and provide names for the concepts. It emphasizes the engineering. This book focuses on the technical parts of software development and what developers do to ensure the system works not job titles or processes. It shows you how to build models and analyze architectures so that you can make principled design tradeoffs. It describes the techniques software designers use to reason about medium to large sized problems and points out where you can learn specialized techniques in more detail. It provides practical advice. Software design decisions influence the architecture and vice versa. The approach in this book embraces drill-down/pop-up behavior by describing models that have various levels of abstraction, from architecture to data structure design.
Download or read book Documenting Software Architectures written by Paul Clements and published by Pearson Education. This book was released on 2010-10-05 with total page 651 pages. Available in PDF, EPUB and Kindle. Book excerpt: Software architecture—the conceptual glue that holds every phase of a project together for its many stakeholders—is widely recognized as a critical element in modern software development. Practitioners have increasingly discovered that close attention to a software system’s architecture pays valuable dividends. Without an architecture that is appropriate for the problem being solved, a project will stumble along or, most likely, fail. Even with a superb architecture, if that architecture is not well understood or well communicated the project is unlikely to succeed. Documenting Software Architectures, Second Edition, provides the most complete and current guidance, independent of language or notation, on how to capture an architecture in a commonly understandable form. Drawing on their extensive experience, the authors first help you decide what information to document, and then, with guidelines and examples (in various notations, including UML), show you how to express an architecture so that others can successfully build, use, and maintain a system from it. The book features rules for sound documentation, the goals and strategies of documentation, architectural views and styles, documentation for software interfaces and software behavior, and templates for capturing and organizing information to generate a coherent package. New and improved in this second edition: Coverage of architectural styles such as service-oriented architectures, multi-tier architectures, and data models Guidance for documentation in an Agile development environment Deeper treatment of documentation of rationale, reflecting best industrial practices Improved templates, reflecting years of use and feedback, and more documentation layout options A new, comprehensive example (available online), featuring documentation of a Web-based service-oriented system Reference guides for three important architecture documentation languages: UML, AADL, and SySML
Download or read book Perspectives on Software Documentation written by Thomas Barker and published by Routledge. This book was released on 2020-11-25 with total page 288 pages. Available in PDF, EPUB and Kindle. Book excerpt: This book is designed to address the randomness of the literature on software documentation. As anyone interested in software documentation is aware, the field is highly synthetic; information about software documentation may be found in engineering, computer science training, technical communication, management, education and so on. "Perspectives on Software Documentation" contains a variety of perspectives, all tied together by the shared need to make software products more usable.
Download or read book The Product is Docs written by Christopher Gales and published by . This book was released on 2020 with total page 287 pages. Available in PDF, EPUB and Kindle. Book excerpt: This book provides a broad perspective about the essential aspects of creating technical documentation in today's product development world. It is a book of opinions and guidance, collected as short essays. You can read selectively about subjects that interest you, or you can read the entire collection in any order you like. Information development is a multidimensional discipline, and it is easy to theorize. We have written this book from our direct experience, using the concrete insights and practices we apply to our work every day. If you work as an information developer, a manager in a documentation team, or in another part of product development that collaborates with a doc team, there is information in this book for you. Perhaps you are a technical writer in a small, high-growth company that is figuring out its processes. Perhaps you are an information-development manager in a large enterprise company with an expanding product line and an ever more complex matrix of cross-functional dependencies. You might work at a medium-sized company where your management is asking you to do more with fewer people, and you want some additional perspective that will help you find a leaner and more effective way to deliver what your business demands. Or you might work outside the technical documentation world, in another part of product development, and are wondering how to collaborate most effectively with the documentation team. The purpose of The Product is Docs is to provoke discussion, shine light on some murky areas, and--we hope--inspire our colleagues to consider their processes and assumptions with new eyes. -- Amazon.
Download or read book Agile Documentation written by Andreas Rüping and published by John Wiley & Sons. This book was released on 2005-01-14 with total page 244 pages. Available in PDF, EPUB and Kindle. Book excerpt: Software documentation forms the basis for all communication relating to a software project. To be truly effective and usable, it should be based on what needs to be known. Agile Documentation provides sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross-referenced, provides solutions to common problems. Straightforward advice will help you to judge: What details should be left in and what left out When communication face-to-face would be better than paper or online How to adapt the documentation process to the requirements of individual projects and build in change How to organise documents and make them easily accessible When to use diagrams rather than text How to choose the right tools and techniques How documentation impacts the customer Better than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real-world examples and utilises agile principles to provide an accessible, practical pattern-based guide which shows how to produce necessary and high quality documentation.
Download or read book Writing Better Computer User Documentation written by R. John Brockmann and published by New York : Wiley & Sons. This book was released on 1990-07-12 with total page 394 pages. Available in PDF, EPUB and Kindle. Book excerpt: Designed to help processing professionals and technical writers write clear, accurate computer user documentation. Presents a systematic approach to writing paper and online documentation. Version 2 retains much essential material from the first edition, while offering new information on desktop publishing, CASE tools and the ``software factory'' programming technologies. Also covers new techniques such as team writing, hypertext, mass storage and more.
Download or read book User Centered Technology written by Robert R. Johnson and published by State University of New York Press. This book was released on 1998-10-29 with total page 218 pages. Available in PDF, EPUB and Kindle. Book excerpt: Winner of the 1999 Best Book presented by the National Council of Teachers of English NCTE Awards for Excellence in Technical and Scientific Communication User-Centered Technology presents a theoretical model for examining technology through a user perspective. Johnson begins with a historical overview of the problem of technological use from the ancient Greeks to the present day—a problem seen most clearly in historical discussions of rhetoric theory. The central portion of the book elaborates on user-centered theory by defining three focal issues of the theory: user knowledge, human-technology interaction, and technological determinism. Working from an interdisciplinary perspective, Johnson uses rhetoric theory to present a definition of user knowledge; human factors engineering to illuminate the ideological presuppositions built into technology design; and history, philosophy, and sociology to explain technological determinism, possibly the greatest impediment to user-centered technology development in modern times. The latter part of the book applies user-centered theory in two contexts: the nonacademic sphere, where the writing and design of computer user documentation is discussed, and the academic sphere, through a discussion of how user-centered concepts might drive university technical communication and composition curricula.
Download or read book Optimized C written by Kurt Guntheroth and published by "O'Reilly Media, Inc.". This book was released on 2016-04-27 with total page 387 pages. Available in PDF, EPUB and Kindle. Book excerpt: In today’s fast and competitive world, a program’s performance is just as important to customers as the features it provides. This practical guide teaches developers performance-tuning principles that enable optimization in C++. You’ll learn how to make code that already embodies best practices of C++ design run faster and consume fewer resources on any computer—whether it’s a watch, phone, workstation, supercomputer, or globe-spanning network of servers. Author Kurt Guntheroth provides several running examples that demonstrate how to apply these principles incrementally to improve existing code so it meets customer requirements for responsiveness and throughput. The advice in this book will prove itself the first time you hear a colleague exclaim, “Wow, that was fast. Who fixed something?” Locate performance hot spots using the profiler and software timers Learn to perform repeatable experiments to measure performance of code changes Optimize use of dynamically allocated variables Improve performance of hot loops and functions Speed up string handling functions Recognize efficient algorithms and optimization patterns Learn the strengths—and weaknesses—of C++ container classes View searching and sorting through an optimizer’s eye Make efficient use of C++ streaming I/O functions Use C++ thread-based concurrency features effectively
Download or read book Creating Effective Software written by David King and published by Prentice Hall. This book was released on 1988 with total page 280 pages. Available in PDF, EPUB and Kindle. Book excerpt:
Download or read book The Future of Software Engineering written by Sebastian Nanz and published by Springer Science & Business Media. This book was released on 2010-10-20 with total page 191 pages. Available in PDF, EPUB and Kindle. Book excerpt: This book focuses on defining the achievements of software engineering in the past decades and showcasing visions for the future. It features a collection of articles by some of the most prominent researchers and technologists who have shaped the field: Barry Boehm, Manfred Broy, Patrick Cousot, Erich Gamma, Yuri Gurevich, Tony Hoare, Michael A. Jackson, Rustan Leino, David L. Parnas, Dieter Rombach, Joseph Sifakis, Niklaus Wirth, Pamela Zave, and Andreas Zeller. The contributed articles reflect the authors‘ individual views on what constitutes the most important issues facing software development. Both research- and technology-oriented contributions are included. The book provides at the same time a record of a symposium held at ETH Zurich on the occasion of Bertrand Meyer‘s 60th birthday.
Download or read book The Information System Consultant s Handbook written by William S. Davis and published by CRC Press. This book was released on 2019-04-30 with total page 792 pages. Available in PDF, EPUB and Kindle. Book excerpt: The Information System Consultant's Handbook familiarizes systems analysts, systems designers, and information systems consultants with underlying principles, specific documentation, and methodologies. Corresponding to the primary stages in the systems development life cycle, the book divides into eight sections: Principles Information Gathering and Problem Definition Project Planning and Project Management Systems Analysis Identifying Alternatives Component Design Testing and Implementation Operation and Maintenance Eighty-two chapters comprise the book, and each chapter covers a single tool, technique, set of principles, or methodology. The clear, concise narrative, supplemented with numerous illustrations and diagrams, makes the material accessible for readers - effectively outlining new and unfamiliar analysis and design topics.
Download or read book The Way of the Web Tester written by Jonathan Rasmusson and published by Pragmatic Bookshelf. This book was released on 2016-09-22 with total page 378 pages. Available in PDF, EPUB and Kindle. Book excerpt: This book is for everyone who needs to test the web. As a tester, you'll automate your tests. As a developer, you'll build more robust solutions. And as a team, you'll gain a vocabulary and a means to coordinate how to write and organize automated tests for the web. Follow the testing pyramid and level up your skills in user interface testing, integration testing, and unit testing. Your new skills will free you up to do other, more important things while letting the computer do the one thing it's really good at: quickly running thousands of repetitive tasks. This book shows you how to do three things: How to write really good automated tests for the web. How to pick and choose the right ones. * How to explain, coordinate, and share your efforts with others. If you're a traditional software tester who has never written an automated test before, this is the perfect book for getting started. Together, we'll go through everything you'll need to start writing your own tests. If you're a developer, but haven't thought much about testing, this book will show you how to move fast without breaking stuff. You'll test RESTful web services and legacy systems, and see how to organize your tests. And if you're a team lead, this is the Rosetta Stone you've been looking for. This book will help you bridge that testing gap between your developers and your testers by giving your team a model to discuss automated testing, and most importantly, to coordinate their efforts. The Way of the Web Tester is packed with cartoons, graphics, best practices, war stories, plenty of humor, and hands-on tutorial exercises that will get you doing the right things, the right way.
Download or read book Literate Programming written by Donald Ervin Knuth and published by Stanford Univ Center for the Study. This book was released on 1992-01 with total page 368 pages. Available in PDF, EPUB and Kindle. Book excerpt: Literate programming is a programming methodology that combines a programming language with a documentation language, making programs more easily maintained than programs written only in a high-level language. A literate programmer is an essayist who writes programs for humans to understand. When programs are written in the recommended style they can be transformed into documents by a document compiler and into efficient code by an algebraic compiler. This anthology of essays includes Knuth's early papers on related topics such as structured programming as well as the Computer Journal article that launched literate programming. Many examples are given, including excerpts from the programs for TeX and METAFONT. The final essay is an example of CWEB, a system for literate programming in C and related languages. Index included.
