Skip to content
This repository has been archived by the owner on Apr 26, 2022. It is now read-only.

footnotes, endnotes, and marginal notes (up to all 3 in one document) #55

Open
RachelComerford opened this issue May 9, 2018 · 1 comment
Assignees
Labels
Best Practice use for Best Practice documentation questions and suggestions

Comments

@RachelComerford
Copy link
Contributor

from BISG survey

@RachelComerford RachelComerford added the Best Practice use for Best Practice documentation questions and suggestions label May 9, 2018
@RachelComerford
Copy link
Contributor Author

@LauraB7 Do you think you could take this one on?

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?

@LauraB7 LauraB7 self-assigned this May 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Best Practice use for Best Practice documentation questions and suggestions
Projects
None yet
Development

No branches or pull requests

2 participants