Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise top-level documentation structure #121

Closed
infotexture opened this issue Dec 1, 2016 · 2 comments
Closed

Revise top-level documentation structure #121

infotexture opened this issue Dec 1, 2016 · 2 comments
Labels
enhancement Changes to an existing topic or feature refactoring Changes to organization of docs source
Milestone

Comments

@infotexture
Copy link
Member

As discussed in March and June docs calls, the artificial book-based distinction between User Guide & Developer Reference in the documentation should be replaced with more task-oriented groupings.

These changes are intended to improve the navigational structure and make frequently accessed topics more discoverable, rather than hiding them under the current “book” titles.

Initial brainstorming suggests top-level items such as:

  • Installing
  • Building/Publishing
  • Customizing/Extending/Plugins
  • Troubleshooting

(Since this change would affect the URL structure of the online docs, it would need to coincide with a major release, since the URLs of topics in released documentation should not be changed.)

The process will begin with a content audit, in which the docs team reviews the current topic structure and proposes new locations in the hierarchy for each topic and suggests index terms for #53.

@infotexture infotexture added enhancement Changes to an existing topic or feature refactoring Changes to organization of docs source labels Dec 1, 2016
@infotexture infotexture added this to the 2.5 milestone Dec 1, 2016
@infotexture infotexture removed this from the 2.5 milestone May 21, 2017
@infotexture
Copy link
Member Author

August 26 IA Brainstorming Results

Here's the proposed outline from @shaneataylor's recent whiteboarding session:

  • about
    • set expectations, including cmd line
    • dita spec support
  • release notes
  • installing
    • migrating from previous versions
  • adding plugins
    • about; source of plugins
    • installing
    • uninstalling
  • building output
    • properties or params
    • dita or ant
    • recommend using log files
    • ref verifying section
  • customizing HTML
  • customizing PDF
  • customizing other output types
  • customizing generated text
    • i18n
    • best practice: text in one plugin and others require it (for what good requiring does)
  • verifying output
    • viewing output
    • viewing logs, log files
  • troubleshooting
    • subtopics for, e.g., HTML included here and in associated sections for building, customizing
  • reference
  • resources

@infotexture
Copy link
Member Author

Proposed outline implemented by @shaneataylor in #162. See PR thread for feedback & discussion.

infotexture pushed a commit that referenced this issue Oct 25, 2017
Implements changes proposed for #121.

Signed-off-by: Shane Taylor <shane@taylortext.com>
@infotexture infotexture added this to the 3.0 milestone Oct 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Changes to an existing topic or feature refactoring Changes to organization of docs source
Projects
None yet
Development

No branches or pull requests

1 participant