Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-30 Thread Robert Brockway
On Wed, 17 Mar 2010, Johnson, Jonathon W Mr CTR USA TRADOC USA wrote: > I guess my question boils down too: is there a "good" way to convert Word > into a wiki format? I've researched this too and am yet to find a good method. > Has anyone found any particularly good wiki software? Currently so

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-19 Thread C.M. Connelly
"JJ" == Johnson, Jonathon W Mr CTR USA TRADOC USA JJ> And as already mentioned, Word adds in A LOT of JJ> other code. I've had reasonable luck in using Mac OS X's TextEdit to do cleaner conversions to HTML. TextEdit can open Word docs nativelyy, and save as HTML. You can specify the d

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Dave Kempe
- "Hugh Brown" wrote: > You might want to have a look at Confluence > (http://www.atlassian.com/software/confluence/). We use it at $WORK > and so far I've found the ACLs easy enough to work with...though for > the most part, our wiki is more open than closed. The latest version > supports w

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Johnson, Jonathon W Mr CTR USA TRADOC USA
he document should things change...and it's still not searchable (well, partially). -Original Message- From: John BORIS [mailto:jbo...@adphila.org] Sent: Wednesday, March 17, 2010 1:26 PM To: 'Shrdlu'; 'Lopsa Discussion'; Jonathon W Mr CTR USA TRADOC USA J

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread John BORIS
arch 17, 2010 12:55 PM To: Lopsa Discussion Subject: Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED) Johnson, Jonathon W Mr CTR USA TRADOC USA wrote: > As yet, I've not found a good way to convert the Word stuff yet. Copying > and pasting is turning into a disaster sin

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Johnson, Jonathon W Mr CTR USA TRADOC USA
code. -Original Message- From: discuss-boun...@lopsa.org [mailto:discuss-boun...@lopsa.org] On Behalf Of Shrdlu Sent: Wednesday, March 17, 2010 12:55 PM To: Lopsa Discussion Subject: Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED) Johnson, Jonathon W Mr CTR USA TRADOC USA

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Shrdlu
Johnson, Jonathon W Mr CTR USA TRADOC USA wrote: > As yet, I've not found a good way to convert the Word stuff yet. Copying > and pasting is turning into a disaster since quite a bit of these documents > are either step by step ordered lists or have many screenshots and/or tables > involved. > >

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread John BORIS
Having worked for the Defense Department and now at $work I have always had to work on the "free" side to get things accomplished. At both places I have used Word Processing documents to handle documentation as it was the only tool that everyone had. At $work I inherited a ton of documentation writ

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Hugh Brown
Johnson, Jonathon W Mr CTR USA TRADOC USA disturbed my sleep to write: > Has anyone found any particularly good wiki software? Currently so far I've > tried quite a few, but none seem to quite meet what I'd like (ie. Screwturn > wiki allows for ACL's, but they are awkward to handle and their categ

Re: [lopsa-discuss] How to improve documentation habits (UNCLASSIFIED)

2010-03-17 Thread Johnson, Jonathon W Mr CTR USA TRADOC USA
Classification: UNCLASSIFIED Caveats: FOUO On Tue, 16 Mar 2010, da...@lang.hm wrote: > I would like to add to this that when you don't have good documentation to > start with, one of the best ways of keeping things in that state is to be > overly picky about the format of the documentation. On a

Re: [lopsa-discuss] How to improve documentation habits

2010-03-16 Thread Aleksey Tsalolikhin
On Tue, Mar 16, 2010 at 1:38 PM, Robert Brockway wrote: > I find that going in and fixing documentation can be a relaxing Friday > afternoon acitivity if you're too burned out to solve some deep technical > problem :)   Does that make me a geek? :) No way, mate. That just makes you a practical s

Re: [lopsa-discuss] How to improve documentation habits

2010-03-16 Thread Robert Brockway
On Tue, 16 Mar 2010, da...@lang.hm wrote: > I would like to add to this that when you don't have good documentation to > start with, one of the best ways of keeping things in that state is to be > overly picky about the format of the documentation. > > eventually it is important to have everything

Re: [lopsa-discuss] How to improve documentation habits

2010-03-16 Thread david
On Mon, 8 Mar 2010, Tom Limoncelli wrote: > The hardest part of doing documentation is getting started. It is > hard to decide what to document, it is hard to tell when you've > documented something well enough. It is hard to get motivated. I would like to add to this that when you don't have g

Re: [lopsa-discuss] How to improve documentation habits

2010-03-16 Thread Joseph Kern
I've been tackling documentation at $work lately ... and here's what I found works for me: Changelog ( A blog for all team members) Pattern Library Runbooks Services Service Name (and general description, links to server runbooks) Procedures Servers Server Name

Re: [lopsa-discuss] How to improve documentation habits

2010-03-08 Thread Tom Limoncelli
On Tue, Mar 2, 2010 at 5:14 PM, wrote: > What does Tom have to say (see Time Management for Sysadmins or The Art & > Practice...)? People have made a number of good points already: Know your audience, figure out your purpose, use something that makes it easy to do (Twiki is my favorite, BTW). T

Re: [lopsa-discuss] How to improve documentation habits

2010-03-08 Thread Aleksey Tsalolikhin
On Tue, Mar 2, 2010 at 5:33 PM, wrote: > But seriously, yes, we've got a wiki in place.  I've used DocBook > before, and I liked it, but honestly, it's hard enough to get people to > use the wiki, let alone the simple wiki markup.  Throw XML into the mix > and buy-in from the team goes way down,

Re: [lopsa-discuss] How to improve documentation habits

2010-03-04 Thread josh+sage
On Wed, Mar 03, 2010 at 02:39:01PM -0500, Brian Mathis wrote: > > One thing I haven't seen so far is a definition of who your audience is. Is > it other admins, help desk, end users, managers, etc...? > > The approach you need to take is very different depending on the answer to > that question.

Re: [lopsa-discuss] How to improve documentation habits

2010-03-03 Thread Brian Mathis
On Mon, Mar 1, 2010 at 7:56 PM, > wrote: > So, I suspect like at least a few of you, I suck at documenting what > I've done. Unless I make a conscious effort to do it as I go along, > it often doesn't get, as the next fire takes priority. > > One thing we've implemented recently at work is a doc

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Matthew Barr
On Mar 2, 2010, at 10:00 PM, Meenoo Shivdasani wrote: >> But what about keeping up with documentation as tasks are accomplished, >> new systems are stood up, etc? What tips do folks have for getting >> better at documenting in their daily tasks? > > I have individual pages for every system and ea

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Meenoo Shivdasani
On Mon, Mar 1, 2010 at 7:56 PM, wrote: > So, I suspect like at least a few of you, I suck at documenting what > I've done.  Unless I make a conscious effort to do it as I go along, > it often doesn't get, as the next fire takes priority. It's not a panacea, but knowing that you need to make a co

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Yves Dorfsman
j...@eldertimes.us wrote: > > But seriously, yes, we've got a wiki in place. I've used DocBook > before, and I liked it, but honestly, it's hard enough to get people to > use the wiki, let alone the simple wiki markup. Throw XML into the mix > and buy-in from the team goes way down, unfortunatel

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread josh
On Tue, Mar 02, 2010 at 11:07:18AM -0800, Aleksey Tsalolikhin wrote: > Do you have an infrastructure for documentation that makes it easy > and pleasurable to add or update documents? If not, you need to > develop one. Personally, I like the power of DocBook XML, and the > convenience of an Asc

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread josh+sage
On Tue, Mar 02, 2010 at 05:14:37PM -0500, berg...@merctech.com wrote: > I include documentation in the "budget"...whether I'm doing an estimate in my > head or presenting a more formal project plan, there's always a documentation > component. > > This way it's clear that documentation is an inte

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread bergman
In the message dated: Mon, 01 Mar 2010 19:56:28 EST, The pithy ruminations from josh+s...@eldertimes.us on <[lopsa-discuss] How to improve documentation habits> were: => So, I suspect like at least a few of you, I suck at documenting what => I've done. Unless I make a conscious effort to do it

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Aleksey Tsalolikhin
On Mon, Mar 1, 2010 at 4:56 PM, wrote: >  What tips do folks have for getting better at documenting in their daily > tasks? Hey, Josh, Do you have an infrastructure for documentation that makes it easy and pleasurable to add or update documents? If not, you need to develop one. Personally,

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Atom Powers
Friday is my semi-official "don't break anything" day; which means I don't start any new projects and I spend as much time as possible writing documentation for things I worked on during the rest of the week. We use our configuration management and source-control systems for "automatic" documentat

Re: [lopsa-discuss] How to improve documentation habits

2010-03-02 Thread Christopher A Manly
The times that I have been best about documenting things, and building the habits to do so, are when I am documenting myself out of a part of a job that I don't want to have to do anymore. I think that "make the new guy write docs" doesn't work because the new guy doesn't know the answers. He