While content creation, till now, we were trying to make use of one video and
one document with an idea that it takes a flow that gives user a feel of a
tutorial, by also covers a problem statement hence also acts as a
how-to guide and at times can also be used as a
We all agree that this setup was maybe necessary when we had less contents for users in the beginning and our aim was to produce quantity in form of documents and videos.
With the user base growing, and with decent number of contents we have, we want to move to the next phase where more standards are in place and there is a definite classification is in place.
In meetings, we had decided on to create a structure, a playlist and classification that segregates the contents in 3 or 4 types.I had reached to my collegues and tried to understand the classification based on which we must structure our content. With their support via discussions and references (source), we are planning to make the effectiveness of the content through these classifications:
These are the lessons that take the learner by the hand through a series of steps to complete a project. The paths will have tutorial content.
In a tutorial you are the teacher and you know what the problems are. You know the things that need to be done and the learner doesn't. You decide for the learner.
Tutorials are learning oriented. It will turn a learner into a user of our product.Tutorials need regular and detailed testing to make sure that they still work.
Guides that take the reader through the steps required to solve a common problem.
The learner has become a user now. A user now has enough knowledge that can ask some meaningful questions and you give the solution.
You can assume that the user already knows how to do basic things and use basic tools.It has steps required to solve a real-world problem.
The techincal descriptions of the machinery and how to operate it. Hence, reference material is information-oriented.They are to the point documents. By all means technical reference can contain examples to illustrate usage, but it should not attempt to explain basic concepts, or how to achieve common tasks.
They clarify and illuminate a particular topic. They are understanding-oriented.A topic isn’t defined by a specific task you want to achieve, like a how-to guide, or what you want the user to learn, like a tutorial. It’s not defined by a piece of the machinery, like reference material. It’s defined by what you think is a reasonable area to try to cover at one time, so the division of topics for discussion can sometimes be a little arbitrary.
Discussionsare the most useful when we are studying
How-tosprovide practical steps
Referencesare the most useful when we are coding
Discussionsprovide theortical understanding.
button with shadow
create rounded border
How to use images in documents
Add meta-data to doc-site
The first thing Harish and I took is Expander.Expander as a unit can be a tutorial.
The concepts it covers are as follows:
CSS properties like:
This part covers basics of Components along with
How-tos associated with it.
The documentation link is added to this part.
It also can be a How-to document but it is more of a how to create events for the expander project.Does not explain Event Handling as a concept.
There are two videos for How to Publish a package. This one is expander specific details.The other one was tailored to make it look generic by taking expander as an example.
Again, Expander specific polishing.No concept level teaching.
This can be classified as a
How tobut document can be a