publ-cg icon indicating copy to clipboard operation
publ-cg copied to clipboard

proper heading structure best practices

Open RachelComerford opened this issue 7 years ago • 2 comments

from BISG survey

RachelComerford avatar May 09 '18 00:05 RachelComerford

Some more related links:

  • http://www.idpf.org/epub/a11y/techniques/#titles-002
  • http://kb.daisy.org/publishing/docs/html/headings.html
  • http://www.idpf.org/epub/profiles/edu/spec/#h.jta7zzjvupxc

mattgarrish avatar May 11 '18 12:05 mattgarrish

As you explore this topic - please keep this guiding structure in mind:

  • identify quirks or exceptions in specific reading systems (edited)
  • Identify gaps in documentation that need to be developed
  • Identify variations based of business verticals - how might you implement this standard differently as journal publisher vs a textbook publisher? A magazine vs scholarly? etc.
  • Use plain language. Use diagrams where they will help (and provide alt text). Tag your colleagues for assistance.
  • If you reference prior art, older development projects, or other materials, provide clarifying information including a basic definition and the importance to the best practice

When you are proposing language/contributions to best practice, please consider and respond to the following questions:

  • What is the problem you are trying to solve?
  • What is your preferred solution and why do you believe this is the best option?
  • What alternatives did you consider?
  • What's the best fallback/back up plan?

RachelComerford avatar May 17 '18 17:05 RachelComerford