Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

\uD83D\uDDD3 Date

\uD83D\uDC65 Participants

📚  Resources

User Documentation Review Process

User Documentation Style Guide

Future User Doc projects

https://docs.google.com/spreadsheets/d/1D6UvIp8iu4NSCcoaFxqRg9V0qluYj7yHfLs8daV8RJo/edit#gid=1782244462

Users Docs ArchivesSpace Instance

\uD83D\uDDE3 Discussion topics

Agenda Item

Description

Notes

Documentation Progress

Anything pending to review?

Thanks for the feedback!

Not sure how to add new pages/change order to /wiki/spaces/ArchivesSpaceUserManual/pages/890339531.

Style Guide

Inconsistent style choices among documentation. Includes:

  • Image border choices (color, size)

  • Image caption and alt text choices (“Fig. 1” or more descriptive)

    • Style guide says to add alt text

  • Use of info panel notes (use per info panel; colors)

  • Use of bold vs. quotes to highlight/emphasize

    • Style guide says to use bold, but notes inconsistent use

  • Alignment of text on page (left vs. center)

    • (Style guide says to align left)

Re-review your assigned pages and make any adjustments based on what was determined today.

Kelly will update the Style Guide as necessary to reflect any decisions made.

User Doc Review Process

Added a sentence for primary watchers to also email secondary watchers when a page is ready for review.

Duplicate Documentation

Additional information can be found in the Future User Doc Projects page

UAC meeting - User Docs discussion

  • Topic

    • Overview of new/updated documentation related to the new release

    • Page consolidation project

User Docs will present at the November 19 meeting

✅ Action items

  •  

⤴ Decisions

  • No labels