|
Books > Language & Literature > Literary & linguistic reference works > Writing & editing guides > Technical writing
Get up to speed with using Mermaid diagrams to facilitate a
seamless development workflow with the help of real-world examples
and expert tips from the creators of the tool Key Features Learn
how to use and customize the different diagram types in Mermaid
Discover examples of how to add Mermaid to a documentation system
Use Mermaid with various tools available such as editors, wiki, and
more Book DescriptionMermaid is a JavaScript-based charting and
diagramming tool that lets you represent diagrams using text and
code, which simplifies the maintenance of complex diagrams. This is
a great option for developers as they're more familiar with code,
rather than using special tools for generating diagrams. Besides,
diagrams in code simplify maintenance and ensure that the code is
supported by version control systems. In some cases, Mermaid makes
refactoring support for name changes possible while also enabling
team collaboration for review distribution and updates. Developers
working with any system will be able to put their knowledge to work
with this practical guide to using Mermaid for documentation. The
book is also a great reference for looking up the syntax for
specific diagrams when authoring diagrams. You'll start by learning
the importance of accurate and visual documentation. Next, the book
introduces Mermaid and establishes how to use it to create
effective documentation. By using different tools, editors, or a
custom documentation platform, you'll also understand how to use
Mermaid syntax for various diagrams. Later chapters cover advanced
configuration settings and theme options to manipulate your diagram
as per your needs. By the end of this book, you'll be well-versed
with Mermaid diagrams and how they can be used in your workflows.
What you will learn Understand good and bad documentation, and the
art of effective documentation Become well-versed with maintaining
complex diagrams with ease Discover how to draw different types of
Mermaid diagrams such as flowcharts, class diagrams, Gantt charts,
and more Implement Mermaid diagrams in your workflows Understand
how to set up themes for a Mermaid diagram or an entire site Get to
grips with setting up a custom documentation system Who this book
is forThis book is for content generators such as technical
writers, developers, architects, business analysts, and managers
who want to learn effective documentation or how to effectively
represent diagrams using simple text code snippets and extract
them. Familiarity with documentation using Markdown will be
helpful, but not necessary.
Well Composed: A Guide to Effective Composition and
Transformational Leadership provides students with an innovative
approach to English composition and rhetoric. The book uniquely
challenges students to develop writing skills and delve into the
study of the foundational concepts in transformational leadership.
Throughout, students are encouraged to introspectively examine
their own level of leadership and self-leadership. The opening
chapter, a transformational leadership rudimentary guide, informs
students of the principles and components of transformational
leadership. Chapter 2 serves as a writing manual that focuses on
composition development, featuring explanations of the patterns of
development, the composition process from word to essay, and
offering samples and visual formats of each pattern. The third
chapter introduces students to the basics of argumentation and
analysis. Each of the remaining chapters focuses on various aspects
of transformational leadership including mindfulness, confidence,
self-discipline, grit, emotional intelligence, diplomacy, and
character, granting opportunity for students to examine some of
America's notable leaders against the backdrop of transformational
leadership. With each chapter providing collaboration and
composition opportunities, as well as class activities designed to
raise students' transformational leadership awareness, the lessons
sharpen students' written, speech, critical thinking, and
collaboration skills and help them develop their voices. The
revised first edition features a completely refreshed interior
design. Well Composed is an essential writing text that encourages
students' expression, introspection, and retrospection. It is an
ideal textbook for courses in English composition, rhetoric, and
college writing, and serves as a profound transformational
leadership primer.
A systematic guide to successfully producing written work for
business and management degrees. The authors address the
all-too-common pitfalls of essay assignments, as well as providing
readers with a step-by-step programme to approach essay questions,
both in coursework and exam contexts. New to the Second Edition:
Relevance of writing skills to employability highlighted throughout
Additional content on researching a topic New content on adapting
writing for different audiences New content on academic writing
tips Addition of useful websites Additional coverage of plagiarism
More on critical evaluation More on changing requirements through
different levels of study. Suitable for all business and management
students looking to improve their essay writing skills. The Student
Success series are essential guides for students of all levels.
From how to think critically and write great essays to planning
your dream career, the Student Success series helps you study
smarter and get the best from your time at university. Visit the
SAGE Study Skills hub for tips and resources for study success!
Science communication is a rapidly expanding area, and a key
component of many final year undergraduate and postgraduate
courses. Authored by a highly regarded chemist and science
communicator, this textbook pulls together all aspects of science
communication. Complete Science Communication focusses on four
major aspects of science communication: writing for non-technical
audiences and science journalism; writing for technical audiences
and peer-reviewed journal writing; public speaking of science; and
public relations. It first showcases how writing in a journalistic
style is done and provides a guide for colloquially communicating
science. Then, the art of writing scientific papers is conjoined to
this idea to make technical manuscripts more digestible, readable,
and, hence, citable. These ideas are next taken into the spoken
word so that the scientist can engage in telling their science like
that natural human art of campfire stories. Finally, all of these
communication concepts are wrapped together in a discussion of
public relations, providing the scientist with an appreciation for
the marketing directors and news disseminators with whom they will
work. Written in an accessible way, this textbook will provide
science students with an appreciative understanding of
communication, marketing, journalism, and public relations. They
can incorporate these aspects into their own practices as
scientists, allowing them to liaise with practitioners in the
communication field.
|
|