how-to-brainstorming: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(add header with process reference, prerequisites, see also)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
<entry-title>how-to brainstorming</entry-title>
{{DISPLAYTITLE:how-to brainstorming}}


This is a page for brainstorming proposals for a how-to microformat for authors and publishers to markup solutions to common problems.
This is a page for brainstorming proposals for a how-to microformat for authors and publishers to markup solutions to common problems.
Line 9: Line 9:


== problem statement ==
== problem statement ==
Every day we are looking for some kind of manual to solve our problems. If we can not effectively use Web search engine, it is quite time consuming task.  
Every day we are looking for some kind of manual to solve our problems. If we can not effectively use Web search engine, it is quite time consuming task. Solution to this problem would be how-to microformat.


== how-to proposal ==
== how-to proposal ==
After reviewing the web microformats.org, I decided to propose microformat for publishing troubleshooting. I called my microformat "how-to" and its schema is as follows:
possible schema of how-to:


* '''how-to''' - main class
* '''howto''' - main class
** '''problem''' - problem which the solution solve.  
** problem - problem which the solution solve.  
** '''domain''' - domain of problem (IT, horticulture)
** category - domain or category of problem (IT, horticulture)
** '''solution''' - element which content solution
** summary
*** difficulty - how difficult is solution for user (technical, equipment, duration, price)
** equipment - working tools and working conditions (hammer, brush tool, some kind of IDE...)
**** technical
** components - parts needed for repair, modification or creation of something that is the subject of the problem, can be used with microformat hProduct
**** equipment
** duration - time duration, used with microformat hCalendar
**** duration
** price
**** price
** instructions - steps to solve problem
*** '''instructions''' - steps to solve problem
** warning
*** inset - insets like images, videos, source codes
** tip
**** hMedia
** author - author of solution (hCard)
**** code
**** rel-enclosure
** faq - element for FAQ, which contents questions and answers
*** question
*** answer
** '''author''' - author of solution (hCard)
** published - datetime of publishing
** published - datetime of publishing
** tag - for keywords, rel-tags
** tag - for keywords, rel-tags


Bold elements should be required. [[User:Juraj|Juraj Sivak]]
== comments ==
 
I think that better property name for working tools and conditions will be '''equipments''' -- [[User:Juraj|Juraj Sivak]]


== see also ==
== see also ==

Latest revision as of 16:27, 18 July 2020


This is a page for brainstorming proposals for a how-to microformat for authors and publishers to markup solutions to common problems.

Per the microformats process, the following pages need to be first created and documented, and then brainstorming should be based upon the research therein.

problem statement

Every day we are looking for some kind of manual to solve our problems. If we can not effectively use Web search engine, it is quite time consuming task. Solution to this problem would be how-to microformat.

how-to proposal

possible schema of how-to:

  • howto - main class
    • problem - problem which the solution solve.
    • category - domain or category of problem (IT, horticulture)
    • summary
    • equipment - working tools and working conditions (hammer, brush tool, some kind of IDE...)
    • components - parts needed for repair, modification or creation of something that is the subject of the problem, can be used with microformat hProduct
    • duration - time duration, used with microformat hCalendar
    • price
    • instructions - steps to solve problem
    • warning
    • tip
    • author - author of solution (hCard)
    • published - datetime of publishing
    • tag - for keywords, rel-tags

comments

I think that better property name for working tools and conditions will be equipments -- Juraj Sivak

see also