Purpose of this document
These are the guidelines that are to be followed when creating a presentation for PI Club’s training sessions.
These guidelines are intended to provide:
- A framework for the presenter(s)
- Consistency across the artifacts produced
To still allow for artistic innovations, this document will impose minimal artistic restrictions within reasonable bounds.
Henceforth, the term artifact refers to the Presentation document produced by the presenter(s).
Structure of this document
The guidelines are divided into four sections:
Aesthetic
This section includes guidelines for the visuals and look-and-feel of the artifacts.
Structural
This section includes guidelines for the structure of the artifacts.
Contentual
This section includes guidelines for the content of the artifacts.
Functional
This section includes guidelines for functions to be performed before, during and after artifact creation.
|------- |
Aesthetic
Structural
- First slide must always be the
title
slide: a. Must have the PI Club's logo. b. Must name the subject(s) covered: * Subject(s) must only be named in singular terms, for example, "html" or "react js". * Subject must not be termed as phrase(s), for example, "Getting started with web pages". c. Must include either the presenter's name or pseudonym: * If a pseudonym is used, it must be used consistently across all the artifacts produced by them. d. May include the date of creation. - Second slide must always be the
overview
slide: a. Must include the list of topics covered. For example, the overview for the subject "html" may include (but are not limited to): - Origin & Usage - Syntax - Common Tags - Nesting
Contentual
- The text should be brief and to the point.
- Technical depth is discouraged unless justifiable.
- Code examples (if any) must: a. Be in text format. b. Be hosted in a github repository.
Functional
- The Presentation slides must include links to further study material, including any github repository.
- The artifact must be approved by the document maintainer.
- The artifact must be stored online:
- Local copies (digital/print) are discouraged.
- A link to the artifact must be shared with the members through PI Club's discord server:
- The artifact must be shared at least 1 day before the presentation
|---------------------------------------------------------------------------------|
Appendix
Created by: @keogami Date of creation: Jan 8th, 2021 Last Modified: Jan 8th, 2021 Version: 1.0.0
Change log
Change description | Changes made by |
---|---|
Created the first version | @keogami |