projectdoc Toolbox

A brief solution to a problem.

Properties

The document type cheat provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Level of Experience

The level of experience expected the cheat addresses.

Sections

Description

Provide an optional overview over the context the cheat is applied in.

Summary

Provide a solution to the problem.

Examples

Provide some examples on how the cheat looks like when applied.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

Related Doctypes

NameShort Description
Annual Vision

Describe your vision for one year. You plan will help you stay focussed to accomplish your goals.

Annual Vision Type

Categories for annual visions.

Asset
Explain an asset of your work. Add this document to a day in your diary.
Asset Type

Categories for assets.

Cheat Type

Categories for cheats.

Day

Store relevant information discovered today in your developer diary.

Day Type

Categories for days.

Diary
The homepage of a developer's daily diary pages. Consider to add your diary to your personal space!
Diary Type

Categories for diaries.

Event
Associated an event with a day. A event is a collection of associated information for your later reference. Information may further be organized by subject, tags, categories, and audience.
Event Type

Categories for events.

Month

Plan and run a retrospective for your month of work.

Month Type

Categories for months.

Todo

Add a todo note to your developer diary.

Todo Type

Categories for todos.

Vision

Describe your vision for your career.

Vision Type

Categories for visions.

Week

Plan and run a retrospective for your week of work.

Week Type

Categories for weeks.

Year

Create a year in your Diary.

Year Type

Categories for years.

Resources


Developer Diaries
A short introduction to developer diaries.
Create a Diary in a Personal Space
The recommended way of creating a diary with the Developer's Diary Add-on is to add a page with the Diary Template in one's Personal Space.