FOLIO Documentation Working Group

Community members who are interested in helping with documentation should reach out to a member of the Working Group to find out how you can help.

Contact / Communication

Slack is our basic tool, our channels are:

Slack channel	purpose
#folio-documentation	general questions regarding FOLIO documentation
#documentation-wg	primarily communication between the members, e.g. next meetings, surveys or discussions

FOLIO documentation and its storage

FOLIO documentation consists of the following tools - repositories and sites:

Site/repository	purpose & good to know
https://docs.folio.org	offcial documentation website - primarily for end user documentation for each released FOLIO version accessible via folio.org available via help icon in FOLIO user interface
https://github.com/folio-org/docs	GitHub repository for version control of all documented content on the official documentation website
DOCs in Jira	To dos concerning content for the official documentation website
FOLIO Individual Apps: Information, Tips and Tricks	Informal community-maintained documentation, e.g. best practise, troubleshooting
Community Contributed Resources	Collected resources from the community

Important information and links

In the following some important facts:

Information/link	purpose
Membership and representative's table on the right	overview of responsabilites contact for community
Resources for Docs WG members / Onboarding support	Basis workflows for our tools, e.g. Google docs, Jira, GitHub Support onboarding for new members Policys
FOLIO DOCS jira ticket	Ask for improvement or addition to documentation by assigning it to responsable member in Jira, if you are not sure who should work on it, please assign so the documentation manager who can find the correct addressee
Meeting agendas and notes	For preparation or look-up
Zoom recordings from the meetings	For absent members or the note takers

d7a2c9-e8c4-4f35-afe4-bdb26fd5e5f0

Future plans

Localization

Internationalization of the Hugo-based docs.folio site has been completed in 2020. A proof-of-concept for the German localization (= actual translation) is being stored on a separate branch (Branch/Pull Request, Preview) until such time that content is ready for inclusion and gets approved by the German translation team.

Context-sensitive Help

Future work should include a mechanism for users to click on an area of the user interface and open the relevant section of the documentation for help.

Working Group Membership

Area	Working Group Representative
Convener / Documentation Manager	Katharina Jung
Home/About	Brandon Katzir
Glossary	(Multiple)
Getting Started	Brandon Katzir
Gettings Started > Installation	Ingolf Kuss
Platform Essentials > Item status	Laurence Mini
Platform Essentials > Keyboard shortcuts	Laurence Mini
Platform Essentials > Locations	Brandon Katzir
Platform Essentials > Permissions	Brandon Katzir
Users	Christine Tobias
RA/Circulation > Check out	Laurence Mini
RA/Circulation > Check in	Laurence Mini
RA/Circulation > Circulation Log	Laurence Mini
RA/Circulation > Courses	Laurence Mini
RA/Circulation > Reading room access app	Laurence Mini
RA/Circulation > Requests	Laurence Mini
RA/Circulation > Additional Topics	Laurence Mini
RM/Acquisitions > Claiming (planned)	unassigned
RM/Acquisitions > Orders	Molly Driscoll
RM/Acquisitions > Finance	Molly Driscoll
RM/Acquisitions > Invoices	Molly Driscoll
RM/Acquisitions > Organizations	Molly Driscoll
RM/Acquisitions > Receiving	Molly Driscoll
Serials	Franziska Wich
RM/Acquisitions > Additional Topics	Molly Driscoll
ERM > Agreements	Emma Raub
ERM > eComparisons	Nadja Ronnisch & Lisa Reek
ERM > eHoldings	Emma Raub
ERM > eUsage	Stefan Dombek
ERM > Licenses	Emma Raub
ERM > Local KB admin	Felix Hemme
MM/Cataloging > Data export	Alissa Hafele
MM/Cataloging > Data import	Alissa Hafele
MM/Cataloging > Inventory	Emily Semenoff
MM/Cataloging > MARCauthority	Lisa Lorenzo
MM/Cataloging > QuickMARC	Lisa Lorenzo
Lists	Christine Tobias
Bulk edit	Amanda Ros (items, holdings), Christine Tobias (users)
Export manager	Molly Driscoll
Dashboard	Emma Raub (ERM)
Reporting	Eliana Lima; Axel Dörrer, Sharon Beltaine, Alexander Chen Lao
Consortium Manager	Wilhelmina Randtke, Christine Tobias
Settings	Aaron Neslin (Tenants), Martina Tumulla (Service interaction) (Multiple)
Liaison to Product Council	Martina Tumulla