Perspectives on Software Documentation

Perspectives on Software Documentation PDF Author: Thomas Barker
Publisher: Routledge
ISBN: 1351842315
Category : Business & Economics
Languages : en
Pages : 288

Get Book Here

Book Description
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.

Perspectives on Software Documentation

Perspectives on Software Documentation PDF Author: Thomas Barker
Publisher: Routledge
ISBN: 1351842315
Category : Business & Economics
Languages : en
Pages : 288

Get Book Here

Book Description
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.

Perspectives on Software Documentation

Perspectives on Software Documentation PDF Author: Thomas T. Barker
Publisher:
ISBN: 9780895030689
Category : Computers
Languages : en
Pages : 279

Get Book Here

Book Description
Two unmistakable trends in software documentation emerge from the academic literature of the last few years. The first trend is toward usability as the standard for all software documentation. The second trend is toward online presentation as the primary & preferred medium for software documentation. As we shall see, this medium allows a number of new interface elements to fall under the broad umbrella of software documentation. In fact, the evidence of these trends tends to suggest that we need to broaden our definition of software documentation. It is toward this broadening that this book inclines. This book is designed to address the randomness of the literature on software documentation. Perspectives on Software Documentation contains a variety of perspectives, all tied together by the shared need to make software products more usable.

Documenting Software Architectures

Documenting Software Architectures PDF Author: Paul Clements
Publisher: Pearson Education
ISBN: 0132488590
Category : Computers
Languages : en
Pages : 651

Get Book Here

Book Description
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

Just Enough Software Architecture

Just Enough Software Architecture PDF Author: George Fairbanks
Publisher: Marshall & Brainerd
ISBN: 0984618104
Category : Computers
Languages : en
Pages : 378

Get Book Here

Book Description
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.

Writing Software Documentation: A Task-Oriented Approach, 2/E

Writing Software Documentation: A Task-Oriented Approach, 2/E PDF Author: Barker
Publisher: Pearson Education India
ISBN: 9788177587692
Category :
Languages : en
Pages : 500

Get Book Here

Book Description


The Product is Docs

The Product is Docs PDF Author: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287

Get Book Here

Book Description
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.

Living Documentation

Living Documentation PDF Author: Cyrille Martraire
Publisher: Addison-Wesley Professional
ISBN: 9780134689326
Category : Computers
Languages : en
Pages : 480

Get Book Here

Book Description
Use an Approach Inspired by Domain-Driven Design to Build Documentation That Evolves to Maximize Value Throughout Your Development Lifecycle Software documentation can come to life, stay dynamic, and actually help you build better software. Writing for developers, coding architects, and other software professionals, Living Documentation shows how to create documentation that evolves throughout your entire design and development lifecycle. Through patterns, clarifying illustrations, and concrete examples, Cyrille Martraire demonstrates how to use well-crafted artifacts and automation to dramatically improve the value of documentation at minimal extra cost. Whatever your domain, language, or technologies, you don't have to choose between working software and comprehensive, high-quality documentation: you can have both. · Extract and augment available knowledge, and make it useful through living curation · Automate the creation of documentation and diagrams that evolve as knowledge changes · Use development tools to refactor documentation · Leverage documentation to improve software designs · Introduce living documentation to new and legacy environments

Documenting Software Architectures : Views and Beyond

Documenting Software Architectures : Views and Beyond PDF Author:
Publisher:
ISBN: 9781282768666
Category : Computer architecture
Languages : en
Pages : 537

Get Book Here

Book Description


The Art of Technical Documentation

The Art of Technical Documentation PDF Author: Katherine Haramundanis
Publisher: Digital Press
ISBN: 1483184013
Category : Computers
Languages : en
Pages : 287

Get Book Here

Book Description
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.

Further Perspectives on Computer Documentation

Further Perspectives on Computer Documentation PDF Author:
Publisher:
ISBN:
Category :
Languages : en
Pages : 5

Get Book Here

Book Description