Chattering random observations, tips, and tutorials on all things related to IT.
I am going through this tutorial and I am very impressed by the quality of this documentation.
http://www.offensive-security.com/metasploit-unleashed/
It got me to think about creating my own personal documentation in such a robust way that any user with enough experience could flawlessly execute what I am documenting. I think that this style of documentation (how-to) would be especially effective on projects that are highly specialized and not frequently used. Many of the documents I create these days follow the how-to format, but my documentation leaves out some of the background and reasons for doing the configuration steps. My initial thought on this omission is the people reading my documents would just want the quick and straightforward route to the answer. I see now that this is effective for some types of configurations, but others require more intimate descriptions to really stick out.
I think going forward I will be focusing on providing even more robust How-to’s on the site and also include more back-story which will provided everyone with a more intimate understanding of the task we are trying to accomplish.
SB
