lotcom.github.io

Lotcom.org Website

View My GitHub Profile

Welcome to Lotcom.org

(aka lotcom.github.io)

Lotcom.org shares creative commons licensed project management checklists, guides, and documentation templates written in Github Flavored Markdown for portability and compatibility.

Document Templates

To view and download available project managment markdown templates, go to https://github.com/lotcom/docTemplates.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

For more details see GitHub Flavored Markdown.

Concise Documentation

“Comprehensive documentation does not ensure project success. In fact, it increases your chance of failure. Documentation should be concise; overviews/roadmaps are generally preferred over detailed documentation. Follow the Agile Modeling (AM) practices: Use the Simplest Tools, Create Simple Content, and Depict Models Simply when creating documentation. The best documentation is the simplest that gets the job done. Don’t create a fifty-page document when a five-page one will do. Don’t create a five-page document when five bullet points will do. Don’t create an elaborate and intricately detailed diagram when a sketch will do. Don’t repeat information found elsewhere when a reference will do. Write in point form. Document only enough to provide a useful context. Start with a document that’s minimal enough for the needs of its customers, then augment it as needed. To determine the minimum amount of documentation that is truly required by your customers, actively explore how they intend to use the documentation and why they are using it that way.”

Quoted from: The Data Administration Newsletter, LLC, Accessed 5/17/19

How to Contribute

Contributions are not currently being accepted at this time.

This website’s content and all shared document templates are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.