Last night I attended a presentation and discussion regarding recent developments in the tools and technologies associated with technical documentation. The forum is sponsored by the DITA Boston Users Group (ditabug). (If you want to know more about DITA and you're not in techdoc, you might want to think about what kind of example you're setting for your children.)
There were plenty of graybeards in attendance, increasing the risk that the conversation would devolve into a fog of long-gone and best-forgotten applications and acronyms.
But, occasionally, there is a point in all this reflection on the past.
Y'see, what's really curious about many of these types of discussions is that we've been having them for at least the 30 years that I've been involved in this business. We've sought to develop methods and tools that would let us write concise descriptions and procedures and easily publish those items in print and online.
There are various other aspect to these goals, including integration with product development (so that the documentation describes the particular version of the product you are using), facilitating translation (so that the same content can be made available in three or 17 languages at the same time that the product is released), reuse (sharing pieces of information among multiple writers), and accessibility (ensuring that people with vision, hearing, or dexterity limitations can use the product and information).
The curious and ultimately frustrating thing about all of this is that we've solved it at least a half dozen times. Like Twain knowing how to quit smoking, we as individuals and as an industry know how to do the right things. We know how to fix these things; we just haven't figured out how to stop breaking them.
see more There I Fixed It
Thursday, January 28, 2010
More on technical documentation
Labels:
more on,
technical.documentation
Subscribe to:
Post Comments (Atom)
Blog Archive
-
►
2015
(7)
- ► 03/08 - 03/15 (2)
- ► 03/01 - 03/08 (1)
- ► 02/01 - 02/08 (2)
- ► 01/25 - 02/01 (1)
- ► 01/11 - 01/18 (1)
-
►
2014
(20)
- ► 11/02 - 11/09 (1)
- ► 10/26 - 11/02 (1)
- ► 10/19 - 10/26 (1)
- ► 10/12 - 10/19 (2)
- ► 09/28 - 10/05 (1)
- ► 09/07 - 09/14 (1)
- ► 08/24 - 08/31 (2)
- ► 08/17 - 08/24 (1)
- ► 07/20 - 07/27 (1)
- ► 07/13 - 07/20 (1)
- ► 06/22 - 06/29 (1)
- ► 05/04 - 05/11 (1)
- ► 04/20 - 04/27 (3)
- ► 04/13 - 04/20 (2)
- ► 04/06 - 04/13 (1)
-
►
2013
(95)
- ► 12/08 - 12/15 (1)
- ► 11/10 - 11/17 (1)
- ► 11/03 - 11/10 (3)
- ► 10/20 - 10/27 (1)
- ► 10/13 - 10/20 (1)
- ► 10/06 - 10/13 (2)
- ► 09/22 - 09/29 (3)
- ► 09/08 - 09/15 (1)
- ► 08/18 - 08/25 (1)
- ► 08/11 - 08/18 (1)
- ► 07/28 - 08/04 (3)
- ► 07/14 - 07/21 (1)
- ► 07/07 - 07/14 (3)
- ► 06/30 - 07/07 (1)
- ► 06/23 - 06/30 (3)
- ► 06/16 - 06/23 (3)
- ► 06/09 - 06/16 (1)
- ► 06/02 - 06/09 (1)
- ► 05/26 - 06/02 (3)
- ► 05/19 - 05/26 (1)
- ► 05/12 - 05/19 (1)
- ► 05/05 - 05/12 (5)
- ► 04/28 - 05/05 (2)
- ► 04/21 - 04/28 (5)
- ► 04/14 - 04/21 (3)
- ► 04/07 - 04/14 (5)
- ► 03/31 - 04/07 (2)
- ► 03/24 - 03/31 (2)
- ► 03/17 - 03/24 (3)
- ► 03/10 - 03/17 (1)
- ► 03/03 - 03/10 (4)
- ► 02/24 - 03/03 (2)
- ► 02/10 - 02/17 (3)
- ► 02/03 - 02/10 (4)
- ► 01/27 - 02/03 (4)
- ► 01/20 - 01/27 (7)
- ► 01/13 - 01/20 (3)
- ► 01/06 - 01/13 (4)
-
►
2012
(261)
- ► 12/30 - 01/06 (2)
- ► 12/23 - 12/30 (4)
- ► 12/16 - 12/23 (3)
- ► 12/09 - 12/16 (4)
- ► 12/02 - 12/09 (3)
- ► 11/25 - 12/02 (4)
- ► 11/18 - 11/25 (1)
- ► 11/11 - 11/18 (4)
- ► 10/28 - 11/04 (2)
- ► 10/21 - 10/28 (2)
- ► 10/14 - 10/21 (4)
- ► 10/07 - 10/14 (1)
- ► 09/30 - 10/07 (3)
- ► 09/23 - 09/30 (2)
- ► 09/16 - 09/23 (5)
- ► 09/09 - 09/16 (2)
- ► 09/02 - 09/09 (1)
- ► 08/26 - 09/02 (3)
- ► 08/19 - 08/26 (5)
- ► 08/12 - 08/19 (4)
- ► 08/05 - 08/12 (4)
- ► 07/29 - 08/05 (3)
- ► 07/22 - 07/29 (3)
- ► 07/15 - 07/22 (9)
- ► 07/08 - 07/15 (6)
- ► 07/01 - 07/08 (11)
- ► 06/24 - 07/01 (9)
- ► 06/17 - 06/24 (7)
- ► 06/10 - 06/17 (6)
- ► 06/03 - 06/10 (12)
- ► 05/27 - 06/03 (11)
- ► 05/20 - 05/27 (17)
- ► 05/13 - 05/20 (9)
- ► 05/06 - 05/13 (26)
- ► 04/29 - 05/06 (2)
- ► 04/22 - 04/29 (8)
- ► 04/15 - 04/22 (1)
- ► 04/08 - 04/15 (3)
- ► 04/01 - 04/08 (6)
- ► 03/25 - 04/01 (2)
- ► 03/18 - 03/25 (2)
- ► 03/11 - 03/18 (3)
- ► 03/04 - 03/11 (2)
- ► 02/26 - 03/04 (3)
- ► 02/19 - 02/26 (6)
- ► 02/12 - 02/19 (6)
- ► 02/05 - 02/12 (6)
- ► 01/29 - 02/05 (3)
- ► 01/22 - 01/29 (5)
- ► 01/15 - 01/22 (5)
- ► 01/08 - 01/15 (3)
- ► 01/01 - 01/08 (3)
-
►
2011
(266)
- ► 12/25 - 01/01 (4)
- ► 12/18 - 12/25 (3)
- ► 12/11 - 12/18 (2)
- ► 12/04 - 12/11 (4)
- ► 11/27 - 12/04 (3)
- ► 11/20 - 11/27 (5)
- ► 11/13 - 11/20 (3)
- ► 11/06 - 11/13 (7)
- ► 10/30 - 11/06 (2)
- ► 10/23 - 10/30 (3)
- ► 10/16 - 10/23 (7)
- ► 10/09 - 10/16 (7)
- ► 10/02 - 10/09 (2)
- ► 09/25 - 10/02 (4)
- ► 09/18 - 09/25 (5)
- ► 09/11 - 09/18 (2)
- ► 09/04 - 09/11 (5)
- ► 08/28 - 09/04 (9)
- ► 08/21 - 08/28 (4)
- ► 08/14 - 08/21 (6)
- ► 08/07 - 08/14 (12)
- ► 07/31 - 08/07 (6)
- ► 07/24 - 07/31 (5)
- ► 07/17 - 07/24 (5)
- ► 07/10 - 07/17 (5)
- ► 07/03 - 07/10 (3)
- ► 06/26 - 07/03 (3)
- ► 06/19 - 06/26 (3)
- ► 06/12 - 06/19 (3)
- ► 06/05 - 06/12 (10)
- ► 05/29 - 06/05 (6)
- ► 05/22 - 05/29 (10)
- ► 05/15 - 05/22 (3)
- ► 05/08 - 05/15 (5)
- ► 05/01 - 05/08 (4)
- ► 04/24 - 05/01 (6)
- ► 04/17 - 04/24 (5)
- ► 04/10 - 04/17 (2)
- ► 03/27 - 04/03 (8)
- ► 03/20 - 03/27 (6)
- ► 03/13 - 03/20 (9)
- ► 03/06 - 03/13 (5)
- ► 02/27 - 03/06 (7)
- ► 02/20 - 02/27 (4)
- ► 02/13 - 02/20 (5)
- ► 02/06 - 02/13 (3)
- ► 01/30 - 02/06 (10)
- ► 01/23 - 01/30 (12)
- ► 01/16 - 01/23 (4)
- ► 01/09 - 01/16 (5)
- ► 01/02 - 01/09 (5)
-
▼
2010
(499)
- ► 12/26 - 01/02 (3)
- ► 12/19 - 12/26 (8)
- ► 12/12 - 12/19 (6)
- ► 12/05 - 12/12 (7)
- ► 11/28 - 12/05 (13)
- ► 11/21 - 11/28 (10)
- ► 11/14 - 11/21 (6)
- ► 11/07 - 11/14 (21)
- ► 10/31 - 11/07 (11)
- ► 10/24 - 10/31 (8)
- ► 10/17 - 10/24 (11)
- ► 10/10 - 10/17 (6)
- ► 10/03 - 10/10 (7)
- ► 09/26 - 10/03 (6)
- ► 09/19 - 09/26 (10)
- ► 09/12 - 09/19 (14)
- ► 09/05 - 09/12 (6)
- ► 08/29 - 09/05 (11)
- ► 08/22 - 08/29 (10)
- ► 08/15 - 08/22 (9)
- ► 08/08 - 08/15 (8)
- ► 08/01 - 08/08 (11)
- ► 07/25 - 08/01 (13)
- ► 07/18 - 07/25 (5)
- ► 07/11 - 07/18 (15)
- ► 07/04 - 07/11 (11)
- ► 06/27 - 07/04 (12)
- ► 06/20 - 06/27 (5)
- ► 06/13 - 06/20 (9)
- ► 06/06 - 06/13 (12)
- ► 05/30 - 06/06 (9)
- ► 05/23 - 05/30 (11)
- ► 05/16 - 05/23 (4)
- ► 05/09 - 05/16 (9)
- ► 05/02 - 05/09 (9)
- ► 04/25 - 05/02 (9)
- ► 04/18 - 04/25 (11)
- ► 04/11 - 04/18 (13)
- ► 04/04 - 04/11 (8)
- ► 03/28 - 04/04 (12)
- ► 03/21 - 03/28 (6)
- ► 03/14 - 03/21 (10)
- ► 03/07 - 03/14 (6)
- ► 02/28 - 03/07 (12)
- ► 02/21 - 02/28 (12)
- ► 02/14 - 02/21 (12)
- ► 02/07 - 02/14 (16)
- ► 01/31 - 02/07 (5)
- ▼ 01/24 - 01/31 (9)
- ► 01/17 - 01/24 (15)
- ► 01/10 - 01/17 (7)
- ► 01/03 - 01/10 (10)
-
►
2009
(534)
- ► 12/27 - 01/03 (9)
- ► 12/20 - 12/27 (12)
- ► 12/13 - 12/20 (15)
- ► 12/06 - 12/13 (13)
- ► 11/29 - 12/06 (11)
- ► 11/22 - 11/29 (17)
- ► 11/15 - 11/22 (6)
- ► 11/08 - 11/15 (14)
- ► 11/01 - 11/08 (6)
- ► 10/25 - 11/01 (8)
- ► 10/18 - 10/25 (10)
- ► 10/11 - 10/18 (12)
- ► 10/04 - 10/11 (12)
- ► 09/27 - 10/04 (9)
- ► 09/20 - 09/27 (15)
- ► 09/13 - 09/20 (11)
- ► 09/06 - 09/13 (9)
- ► 08/30 - 09/06 (3)
- ► 08/23 - 08/30 (7)
- ► 08/16 - 08/23 (11)
- ► 08/09 - 08/16 (11)
- ► 08/02 - 08/09 (5)
- ► 07/26 - 08/02 (21)
- ► 07/19 - 07/26 (3)
- ► 07/12 - 07/19 (18)
- ► 07/05 - 07/12 (8)
- ► 06/28 - 07/05 (6)
- ► 06/14 - 06/21 (2)
- ► 06/07 - 06/14 (15)
- ► 05/31 - 06/07 (8)
- ► 05/24 - 05/31 (6)
- ► 05/17 - 05/24 (12)
- ► 05/10 - 05/17 (9)
- ► 05/03 - 05/10 (12)
- ► 04/26 - 05/03 (10)
- ► 04/19 - 04/26 (19)
- ► 04/12 - 04/19 (8)
- ► 04/05 - 04/12 (17)
- ► 03/29 - 04/05 (18)
- ► 03/22 - 03/29 (14)
- ► 03/15 - 03/22 (10)
- ► 03/08 - 03/15 (13)
- ► 03/01 - 03/08 (20)
- ► 02/22 - 03/01 (7)
- ► 02/15 - 02/22 (3)
- ► 02/08 - 02/15 (6)
- ► 02/01 - 02/08 (4)
- ► 01/25 - 02/01 (7)
- ► 01/18 - 01/25 (13)
- ► 01/11 - 01/18 (8)
- ► 01/04 - 01/11 (11)
-
►
2008
(488)
- ► 12/28 - 01/04 (5)
- ► 12/21 - 12/28 (2)
- ► 12/14 - 12/21 (1)
- ► 12/07 - 12/14 (12)
- ► 11/30 - 12/07 (13)
- ► 11/23 - 11/30 (14)
- ► 11/16 - 11/23 (12)
- ► 11/09 - 11/16 (11)
- ► 11/02 - 11/09 (4)
- ► 10/26 - 11/02 (13)
- ► 10/19 - 10/26 (14)
- ► 10/12 - 10/19 (11)
- ► 10/05 - 10/12 (11)
- ► 09/28 - 10/05 (16)
- ► 09/21 - 09/28 (20)
- ► 09/14 - 09/21 (8)
- ► 09/07 - 09/14 (16)
- ► 08/31 - 09/07 (7)
- ► 08/24 - 08/31 (14)
- ► 08/17 - 08/24 (12)
- ► 08/10 - 08/17 (7)
- ► 08/03 - 08/10 (3)
- ► 07/27 - 08/03 (1)
- ► 07/20 - 07/27 (2)
- ► 07/13 - 07/20 (9)
- ► 07/06 - 07/13 (6)
- ► 06/29 - 07/06 (12)
- ► 06/22 - 06/29 (11)
- ► 06/15 - 06/22 (10)
- ► 06/08 - 06/15 (8)
- ► 06/01 - 06/08 (12)
- ► 05/25 - 06/01 (10)
- ► 05/18 - 05/25 (5)
- ► 05/11 - 05/18 (11)
- ► 05/04 - 05/11 (9)
- ► 04/27 - 05/04 (11)
- ► 04/20 - 04/27 (13)
- ► 04/13 - 04/20 (9)
- ► 04/06 - 04/13 (12)
- ► 03/30 - 04/06 (8)
- ► 03/23 - 03/30 (10)
- ► 03/16 - 03/23 (13)
- ► 03/09 - 03/16 (5)
- ► 03/02 - 03/09 (4)
- ► 02/24 - 03/02 (7)
- ► 02/17 - 02/24 (6)
- ► 02/10 - 02/17 (6)
- ► 02/03 - 02/10 (6)
- ► 01/27 - 02/03 (10)
- ► 01/20 - 01/27 (14)
- ► 01/13 - 01/20 (14)
- ► 01/06 - 01/13 (8)
-
►
2007
(168)
- ► 12/30 - 01/06 (7)
- ► 12/16 - 12/23 (8)
- ► 12/09 - 12/16 (12)
- ► 12/02 - 12/09 (5)
- ► 11/25 - 12/02 (6)
- ► 11/18 - 11/25 (6)
- ► 11/11 - 11/18 (1)
- ► 11/04 - 11/11 (4)
- ► 10/28 - 11/04 (3)
- ► 10/21 - 10/28 (8)
- ► 10/14 - 10/21 (4)
- ► 10/07 - 10/14 (5)
- ► 09/30 - 10/07 (5)
- ► 09/23 - 09/30 (10)
- ► 09/16 - 09/23 (8)
- ► 09/09 - 09/16 (1)
- ► 08/19 - 08/26 (2)
- ► 08/12 - 08/19 (7)
- ► 08/05 - 08/12 (3)
- ► 07/29 - 08/05 (8)
- ► 07/22 - 07/29 (11)
- ► 07/15 - 07/22 (1)
- ► 07/08 - 07/15 (3)
- ► 07/01 - 07/08 (2)
- ► 06/24 - 07/01 (6)
- ► 06/17 - 06/24 (3)
- ► 06/10 - 06/17 (4)
- ► 06/03 - 06/10 (3)
- ► 05/27 - 06/03 (1)
- ► 05/13 - 05/20 (1)
- ► 04/29 - 05/06 (2)
- ► 04/22 - 04/29 (2)
- ► 04/15 - 04/22 (1)
- ► 04/01 - 04/08 (1)
- ► 03/18 - 03/25 (1)
- ► 03/11 - 03/18 (3)
- ► 02/25 - 03/04 (1)
- ► 02/11 - 02/18 (2)
- ► 02/04 - 02/11 (3)
- ► 01/21 - 01/28 (2)
- ► 01/14 - 01/21 (2)
-
►
2006
(144)
- ► 12/03 - 12/10 (1)
- ► 11/26 - 12/03 (2)
- ► 11/19 - 11/26 (1)
- ► 11/12 - 11/19 (3)
- ► 10/29 - 11/05 (2)
- ► 10/22 - 10/29 (1)
- ► 10/15 - 10/22 (1)
- ► 10/08 - 10/15 (1)
- ► 10/01 - 10/08 (1)
- ► 09/24 - 10/01 (3)
- ► 09/17 - 09/24 (2)
- ► 09/10 - 09/17 (2)
- ► 08/20 - 08/27 (1)
- ► 08/06 - 08/13 (1)
- ► 07/30 - 08/06 (2)
- ► 07/23 - 07/30 (2)
- ► 07/16 - 07/23 (2)
- ► 07/09 - 07/16 (3)
- ► 07/02 - 07/09 (3)
- ► 06/25 - 07/02 (6)
- ► 06/18 - 06/25 (2)
- ► 06/11 - 06/18 (1)
- ► 06/04 - 06/11 (3)
- ► 05/28 - 06/04 (3)
- ► 05/14 - 05/21 (3)
- ► 05/07 - 05/14 (5)
- ► 04/30 - 05/07 (4)
- ► 04/23 - 04/30 (2)
- ► 04/16 - 04/23 (3)
- ► 04/09 - 04/16 (5)
- ► 04/02 - 04/09 (5)
- ► 03/26 - 04/02 (4)
- ► 03/19 - 03/26 (5)
- ► 03/12 - 03/19 (5)
- ► 03/05 - 03/12 (4)
- ► 02/26 - 03/05 (4)
- ► 02/19 - 02/26 (5)
- ► 02/12 - 02/19 (6)
- ► 02/05 - 02/12 (6)
- ► 01/29 - 02/05 (9)
- ► 01/22 - 01/29 (4)
- ► 01/15 - 01/22 (5)
- ► 01/08 - 01/15 (5)
- ► 01/01 - 01/08 (6)
-
►
2005
(218)
- ► 12/25 - 01/01 (4)
- ► 12/18 - 12/25 (1)
- ► 12/11 - 12/18 (4)
- ► 12/04 - 12/11 (1)
- ► 11/27 - 12/04 (1)
- ► 11/20 - 11/27 (2)
- ► 11/06 - 11/13 (2)
- ► 10/30 - 11/06 (2)
- ► 10/16 - 10/23 (1)
- ► 10/09 - 10/16 (3)
- ► 09/25 - 10/02 (1)
- ► 09/18 - 09/25 (1)
- ► 09/11 - 09/18 (1)
- ► 09/04 - 09/11 (1)
- ► 08/28 - 09/04 (1)
- ► 08/21 - 08/28 (2)
- ► 08/14 - 08/21 (3)
- ► 08/07 - 08/14 (4)
- ► 07/31 - 08/07 (2)
- ► 07/24 - 07/31 (5)
- ► 07/17 - 07/24 (3)
- ► 07/10 - 07/17 (5)
- ► 07/03 - 07/10 (4)
- ► 06/26 - 07/03 (5)
- ► 06/19 - 06/26 (5)
- ► 06/12 - 06/19 (5)
- ► 06/05 - 06/12 (5)
- ► 05/29 - 06/05 (3)
- ► 05/22 - 05/29 (5)
- ► 05/15 - 05/22 (6)
- ► 05/08 - 05/15 (6)
- ► 05/01 - 05/08 (7)
- ► 04/24 - 05/01 (7)
- ► 04/17 - 04/24 (6)
- ► 04/10 - 04/17 (6)
- ► 04/03 - 04/10 (6)
- ► 03/27 - 04/03 (7)
- ► 03/20 - 03/27 (8)
- ► 03/13 - 03/20 (7)
- ► 03/06 - 03/13 (7)
- ► 02/27 - 03/06 (7)
- ► 02/20 - 02/27 (7)
- ► 02/13 - 02/20 (8)
- ► 02/06 - 02/13 (8)
- ► 01/30 - 02/06 (7)
- ► 01/23 - 01/30 (7)
- ► 01/16 - 01/23 (7)
- ► 01/09 - 01/16 (6)
- ► 01/02 - 01/09 (6)
-
►
2004
(159)
- ► 12/26 - 01/02 (6)
- ► 12/19 - 12/26 (8)
- ► 12/12 - 12/19 (9)
- ► 12/05 - 12/12 (5)
- ► 11/28 - 12/05 (9)
- ► 11/21 - 11/28 (6)
- ► 11/14 - 11/21 (4)
- ► 11/07 - 11/14 (6)
- ► 10/31 - 11/07 (5)
- ► 10/24 - 10/31 (5)
- ► 10/17 - 10/24 (4)
- ► 10/10 - 10/17 (4)
- ► 10/03 - 10/10 (4)
- ► 09/26 - 10/03 (3)
- ► 09/19 - 09/26 (3)
- ► 09/12 - 09/19 (3)
- ► 08/29 - 09/05 (3)
- ► 08/22 - 08/29 (6)
- ► 08/15 - 08/22 (1)
- ► 08/08 - 08/15 (2)
- ► 08/01 - 08/08 (1)
- ► 07/25 - 08/01 (1)
- ► 07/18 - 07/25 (3)
- ► 07/11 - 07/18 (5)
- ► 06/27 - 07/04 (4)
- ► 06/20 - 06/27 (5)
- ► 06/13 - 06/20 (4)
- ► 06/06 - 06/13 (6)
- ► 05/30 - 06/06 (3)
- ► 05/23 - 05/30 (3)
- ► 05/16 - 05/23 (1)
- ► 05/09 - 05/16 (5)
- ► 05/02 - 05/09 (5)
- ► 04/25 - 05/02 (4)
- ► 04/18 - 04/25 (7)
- ► 04/11 - 04/18 (6)
No comments:
Post a Comment