|
|
Books > Language & Literature > Literary & linguistic reference works > Writing & editing guides > Technical writing
This Guide is intended for writers that develop specifications for
the Federal Highway Administration's (FHWA) Federal Lands Highway
Program (FLH). This Guide is to promote and facilitate the writing
of specifications that conform to the five Cs of specification
writing - clear, concise, complete, correct, and consistent.
Adherence to the guidance provided in these chapters and Chapter
9.4.11 of the FLH's Project Development and Design Manual will help
writers develop well-written specifications for use with the
Standard Specification for Construction of Road and Bridges on
Federal Highway Projects (FP). The FP in and of itself is a good
example of proper style and format. This document contains
guidelines to help writers develop specifications for the Federal
Highway Administration's Federal Lands Highway program. Topics
addressed include: Specification writing style; Organization and
format, Proper terminology and phrasing; Capitalization and
abbreviation; and Punctuation and grammar rules.
G. John Sagmiller's documents and notes he has used as a Baan and
LN consultant for over 15 years. Mr. Sagmiller is an Infor and BAAN
ERP system information expert. This is the Common Module
information.
Report writing skills are essential to success in your code
enforcement career. Your notices of violation, letters, and reports
are public documents that may be read by supervisors, attorneys,
judges, citizens, design professionals, contractors, and reporters.
Quality inspection reports and notices of violation help ensure
code compliance, impress superiors, and win respect from
colleagues. They facilitate repairs, reinforce requirements for
safe operations, and ensure unsafe practices are discontinued.
"Report Writing for Code Inspectors" covers a wide range of topics:
basic principles for organizing and writing reports, bullet style,
punctuation, capitalization, sentence structure, English usage, and
the specialized vocabulary you need for your reports. Sample
reports are included, along with a pre-test, post-test, practice
exercises, and a complete answer key.
"Effective writing: plain English at work" is about writing that
works: it is based on sound English grammar and plain English
style. Through this book you will gain the skills needed to write
cohesive paragraphs and to consider your target audience. This
second, updated edition also considers workplace writing not
covered in the first edition such as writing emails and material
for websites. Each topic includes activities (and solutions) for
you to practise your writing and check your progress. Use this book
as a self-teaching aid or as a class textbook.
A practical guide to managing technical writing projects and tech
writing departments, covering hiring, evaluation, management,
internal and external customer relations, estimating and tracking
tech writing projects, running a tech writing business as a solo
contractor or as a manager, selling writing services, contracts and
work orders, outsourcing, technical training development &
delivery, and more. From the Introduction: "There are many books
available on the techniques of technical writing, primarily for
beginners and practitioners of tech writing. But there are very few
books on how to manage the technical writing group in a company or
how to manage a technical writing business (whether you're on your
own as a freelancer or you have writers working for you). If you
are a tech writer who manages other writers, or if you are a
non-writer who manages writers, this book is for you. The sections
on managing tech writing projects show a methodology specific to
technical documentation. If you want to learn general management
and project management techniques-and you should-that information
already exists. What this book aims for is to provide you as a
manager of technical writing with the specifics that you won't
easily find elsewhere. Secondarily, this book aims to give new
managers, and future managers, a leg up on how to actually run a
technical publications group, based on some 20 years of experience
in the field. There are different situations in which someone
becomes a manager of a technical publications group. Sometimes a
writer grows into the role within a company as the department
grows, sometimes tech writers are subsumed under some other group -
I've seen writers belonging to support, testing, marketing, and
infrastructure groups - and the person in charge of technical
writing in the company isn't actually a writer and may never have
been one. Tech writers who set up their own freelance business have
their own specific needs: not only are they the managers, they're
also the writers. Finally, owners or managers of tech writing
agencies, whether or not they are writers themselves, have business
issues specific to a tech writing business to consider." Contents:
Chapter 1Introduction * A guide for technical writing managers *
Writers who become managers * Managers who are not tech writers *
Freelance tech writers * Tech writing agency owners * What's in
this book Chapter 2Tech writing for managers * A quick intro to
technical writing * Technical editing * Technical writing and
product management * Tech writing and debugging * What skills do
technical writers need? Chapter 3How to hire tech writers *
Establish the requirements * Evaluate the resumes * Interview the
writers * Review the samples * Give a test * Tech writers with
non-tech writing experience Chapter 4Managing a tech writing group
* The role of tech writers in a corporate environment * The
documentation team * Define standards * Distribute the work in your
team * Involve the writers * Build teams * Monitor the work and
communications * Evaluate the writers * Client relations *
Communicating with other groups in your organization * Corporate
tech writing * Re-use, repurposing, and content management systems
Chapter 5Estimating, tracking, and managing tech writing projects *
Determine the project scope * Estimates and schedules * Assemble
the team * Provide resources and leadership * Working with
outsourced writers or outsourced SMEs * Track and report * Deliver
the project * Evaluate the project Chapter 6Running a tech writing
business * Finding jobs * Marketing yourself as a freelance tech
writer * Other marketing avenues * Managing your clients Chapter
7Managing technical training * How to do tech training * Training
program components * Training needs analysis * Training development
* Training delivery * Training delivery management * Training
program communication * Training budget * Set the tone: fun
exploration * Training eval
With the release of SharePoint 2013 comes a whole new raft of
technologies to understand and implement. This book will go through
the setting up of SharePoint 2013 itself from creating the setup
accounts to the actual install of the software. We won't be
covering the installation of SQL Server in this book, we assumes
you have a functioning SQL Server ready for the installation of
SharePoint 2013, for all examples an instance of SQL 2012 server is
used. The book will also cover the setup and implementation of the
new Microsoft Workflow Manager and Office Web Apps which now run as
separate servers and are accessed by SharePoint 2013. This book
uses a very simple infrastructure model which is ideal for
demonstrating the techniques for installing SharePoint 2013 and its
associated servers, but this model should not be used in a
production environment.
Donna Fox's debut book, The Nerdy Writer, provides a roadmap for
people who want to author technology-based documents or desire to
become technical writers. The first part describes her journey into
a rewarding career as a technical writer. The second part of the
book focuses on important aspects of the profession (i.e.,
technical writing skills, related job titles, the document
development process, audience analysis, tools, getting a technical
writing job and upward mobility opportunities).
|
|