Add comprehensive end-user documentation for installation and XML validation

[Copilot]

Overview

This PR addresses issue #[issue_number] by providing complete user documentation for MarkAPI, designed specifically for non-developer end users. The documentation enables users to install, configure, and use MarkAPI's XML validation features without requiring technical expertise.

What's New

📚 User Documentation Structure

Created a new docs/user-guide/ directory containing comprehensive guides in Portuguese (Brazilian):

1. Installation Guide (01-Installation-Guide.md)

   • Step-by-step Docker installation for Linux, Windows, and macOS
   • Production deployment options (Docker Compose and Kubernetes)
   • Environment configuration and database setup
   • Useful commands for maintenance, backup, and troubleshooting
   • Common problems and solutions

2. XML Validation Guide (02-XML-Validation-Guide.md)

   • How to access the system and upload XML files
   • Detailed explanation of validation reports and error levels (ERROR, WARNING, INFO)
   • Instructions for correcting issues and revalidating documents
   • API usage for advanced automation scenarios
   • Best practices and recommended workflows

3. User Documentation Index (README.md)

   • Overview of all available guides
   • FAQ and quick reference
   • Navigation for different user types (editors, administrators, content reviewers)

4. Wiki Publication Guide (Wiki-Content-Summary.md)

   • Instructions for publishing documentation to GitHub Wiki
   • Page mapping and structure recommendations
   • Maintenance guidelines for keeping docs synchronized

🔗 Integration

Updated the main README.md to include a prominent "Documentation for End Users" section that links to all user guides, making them easily discoverable.

Documentation Highlights

• 1,100+ lines of comprehensive, user-friendly content
• Non-technical language suitable for end users without development background
• Platform coverage for all major operating systems
• Practical examples and real-world scenarios
• Troubleshooting sections for common issues
• Best practices for validation workflows

Target Audience

The documentation serves multiple user personas:

• 👨‍💼 Editors and Coordinators: Focus on XML upload and validation report interpretation
• 👨‍💻 System Administrators: Complete installation and maintenance procedures
• 📝 Content Authors: XML preparation and error correction guidance

GitHub Wiki Ready

All documentation is formatted for easy publication to the project wiki at https://github.com/scieloorg/markapi/wiki, with a dedicated guide explaining the publication process.

Related Documentation

This documentation complements existing technical documentation and provides the user-facing counterpart to:

• Developer setup guides in the main README
• Technical API documentation
• Existing wiki page on PDF model configuration

Testing

Documentation has been:

• ✅ Reviewed for markdown syntax correctness
• ✅ Verified for completeness against issue requirements
• ✅ Structured with clear navigation and cross-references
• ✅ Written in accessible Portuguese for the target audience

---

Closes #[issue_number]

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Completar a documentação da aplicação para o usuário final</issue_title>
<issue_description>### Descrição da tarefa
Complete a documentação para o usuário final
https://github.com/scieloorg/markapi/wiki

• instrução de como instalar (análogo a https://github.com/scieloorg/opac_5/wiki/Upload-application-installation, no entanto, note que o público não é desenvolvedor)
• instrução de como usar a validação de XML (análogo a https://github.com/scieloorg/markapi/wiki/Converter-XML-para-PDF)
  </issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #30

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.