Docs Like Code

2017-09-09 Computers

Author : Anne Gentle
Release : 2017-09-09
Genre : Computers
Kind : eBook
Book Rating : 322/5 ( reviews)

GET EBOOK

Book Synopsis Docs Like Code by : Anne Gentle

Download or read book Docs Like Code written by Anne Gentle. This book was released on 2017-09-09. 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.

Docs for Developers

2021-10-01 Computers

Author : Jared Bhatti
Release : 2021-10-01
Genre : Computers
Kind : eBook
Book Rating : 169/5 ( reviews)

GET EBOOK

Book Synopsis Docs for Developers by : Jared Bhatti

Download or read book Docs for Developers written by Jared Bhatti. This book was released on 2021-10-01. Available in PDF, EPUB and Kindle. Book excerpt: Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation. Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization. What You'll Learn Create friction logs and perform user research to understand your users’ frustrations Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes Publish and maintain documentation alongside regular code releases Measure the success of the content you create through analytics and user feedback Organize larger sets of documentation to help users find the right information at the right time Who This Book Is For Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.

Robust Python

2021-07-12 Computers

Author : Patrick Viafore
Release : 2021-07-12
Genre : Computers
Kind : eBook
Book Rating : 611/5 ( reviews)

GET EBOOK

Book Synopsis Robust Python by : Patrick Viafore

Download or read book Robust Python written by Patrick Viafore. This book was released on 2021-07-12. Available in PDF, EPUB and Kindle. Book excerpt: Does it seem like your Python projects are getting bigger and bigger? Are you feeling the pain as your codebase expands and gets tougher to debug and maintain? Python is an easy language to learn and use, but that also means systems can quickly grow beyond comprehension. Thankfully, Python has features to help developers overcome maintainability woes. In this practical book, author Patrick Viafore shows you how to use Python's type system to the max. You'll look at user-defined types, such as classes and enums, and Python's type hinting system. You'll also learn how to make Python extensible and how to use a comprehensive testing strategy as a safety net. With these tips and techniques, you'll write clearer and more maintainable code. Learn why types are essential in modern development ecosystems Understand how type choices such as classes, dictionaries, and enums reflect specific intents Make Python extensible for the future without adding bloat Use popular Python tools to increase the safety and robustness of your codebase Evaluate current code to detect common maintainability gotchas Build a safety net around your codebase with linters and tests

Code Craft

2007 Computers

Author : Pete Goodliffe
Release : 2007
Genre : Computers
Kind : eBook
Book Rating : 190/5 ( reviews)

GET EBOOK

Book Synopsis Code Craft by : Pete Goodliffe

Download or read book Code Craft written by Pete Goodliffe. This book was released on 2007. Available in PDF, EPUB and Kindle. Book excerpt: A guide to writing computer code covers such topics as variable naming, presentation style, error handling, and security.

Conversation and Community

2012 COMPUTERS

Author : Anne Gentle
Release : 2012
Genre : COMPUTERS
Kind : eBook
Book Rating : 106/5 ( reviews)

GET EBOOK

Book Synopsis Conversation and Community by : Anne Gentle

Download or read book Conversation and Community written by Anne Gentle. This book was released on 2012. Available in PDF, EPUB and Kindle. Book excerpt: Anne Gentle's "Conversation and Community" has become the go-to reference for social media and technical communication. Her clear-eyed survey of the social media landscape has been adopted by many universities and is widely used by technical communicators. Now, in this second edition, she has updated and expanded her book, adding chapters on building a content strategy, analyzing web techniques, and developing an open source strategy. With more interviews and case studies, this is your guide to the new world of technical communication and social media. Inside the Book Towards the Future of Documentation Defining a Writer's Role with the Social Web Community and Documentation Commenting and Connecting with Users Wikis as Documentation Systems Finding Your Voice Content Strategy for Community Documentation NEW Chapter Analyzing and Measuring Web Techniques NEW Chapter Open Source Documentation NEW Chapter Concepts and Tools of the Social Web Glossary, Expanded Bibliography, and Index

Popular eBooks

Docs Like Code

Docs for Developers

Robust Python

Code Craft

Conversation and Community

You may also like...