AyMINE – Technical documentation
sys
- Translations
- System Management
- User Administration
- System User
- Documents and files
- System Groups and Teams for rights settings
- Record Relationships
- Client
- Dashboard
- Public link to the document
- Client settings
- Revisions and comments
- User administration
- Copying and moving files between objects
- Object location on the board
- Additional functions with files
- Client items
- Picture presentation
- Secure login to the sytem
- Configure gateways for external messages
- Connecting users to VOIP PBX
- Call directly from CRM
- Send SMS directly from CRM
- Formatted texts in the application
- Secure business communication
- System Configuration
- User Processes
- Processes in use
- Message with the outside world
- Email messages
- Relation types
- Securing posts and internal discussions
- Recent Files
- Crypto Wallet
- Electronic sign even on mobile device
tsk
- Required qualifications
- Package definition
- Phrases and terms
- Data Area
- Test
- Risk
- Task
- Business event
- Task, project & quality management
- Records and protocols
- Directives and Policies
- Events
- Risk Pattern
- Information
- Meeting
- Problems, tickets and their management
- Plan template / strategy
- Decision
- Configuration Package
- Record template
- Change management process in a project
- Task list
- Requirements
- Team Member
- Right to Manage Qualifications
- Input requirements
- Obligation
- Competencies and Skills
- Project definition
- Activity log
- List of event instances
- Task patterns saves work and improve quality
- Methodology and Quality Management systems
- My Tasks
- Task planning both in project and daily business
- Project Team
- Events and meetings
- Sample tasks and methodologies of the area
- Events and meetings
- List of event instances
- Client Settings
- Processed objects
- Mark patterns
- Manage your marks
- Region / project / methodology
- Personal calendar
- Objects of decision making
- Event activation buttons
- Objects affected by the problem
- Variant decision-making
- Recorded activities
- Self-Reminders
- Assigning a new task
- Objects related to the task pattern
- Effect of the task on the right to modify the attached object
- Level of Competence
- Manager approval with the task report
- Requirements waiting for you
- Notification events
- List of business areas
- Qualification of user or contact
- Activation buttons
- Why some data can't be deleted
- Starting events
- Qualification of user or contact
- My projects
- Objects processed in the task
- Project
- Reminders and Messages
- Notification events
- Objects of decision making
- Starting events
- Sample tasks and methodologies of the area
- Activation buttons
- Records managed by a project
- Timesheet
- Project role
- What makes up the methodology / SMJ
- Drag & Drop between records
- Location
- My areas
- Kanban Task Overview
- Personal Task
- Internal helpdesk
- Customer Care Centre
- Project baseline
- Return project plan by baseline
- Project Schedule
- Type of tests
- The person responsible for the task
- Deals / Contracts
- Customer Service Response Generation
- 8D report - tool for problem resolution
- Task Scheduling
- Administration of the Task Management Module
- Adminitration of areas, projects, calendars
- Discussion
- GDPR and record of qualifications
- System rights for the task management module
- Project Planning
- Employee Tasks
- Incident and Quality Issue Management
- Collaborative Resolution of Multiple Problems
- Notice – example of use
- FMEA criteria for detection evaluation
- FMEA system functionality analysis
- Methodology how to conduct FMEA
- FMEA analysis of the failure occurence
- Analysis of the FMEA Severity
- FMEA Analysis
- Management of responsibilities - RACI Matrix
- RACI Matrix for Project
- Improvements and Preventive Measures
crm
- Directory or people and companies
- Address books
- Contact per person or company
- Order overview for customer groups
- Customer Order Overview
- Message patterns
- Quickly available contacts
- Contacts and directories module (
- Address book list and management
- Privacy policy
- Groups of contacts
- System Permissions and CRM Module Settings
- Contracts
- Send bulk messages in compliance with GDPR
- Bulk email footer
- Bulk Emails
- Partner in a contract
- Unsubscribe and set preferences
for bulk mail - How to correctly forget a person's details
am
- Product Categories
- Shared analytical model accelerate your project and development
- Products, assets and sales
- Products and Goods
- Tendering and purchasing
- Product Supplier
- Product status and change
- Project Goal
- Business Offer
- Recalculate bid
- Pricing
- Pricing – volume discounts
- Offers summaries
- Order Reports
- Quality criteria
- Creating and processing orders
- Product or Product Property
- Why are the Quality criteria usefull
- DFEMA - FMEA of the product design
- HARA for product
- Offer and Price Access Rights
- Product Units
- System order status query
frm
- List of records
The AyMINE Framework Module- AyMINE releases
- AyMINE – Initial advice
- AyMINE Modules
- Object locks
- Configure how your system looks and works
- Filtering in the list of records
- Icons in AyMINE
- Deleting
- Your main dashboard
- Object lists
- More about how the system works
- Object detail
- Private notes and tags for objects
- ClipLink
- Gestures and keyboard shortcuts
- Drag & Drop between records
- System rights
- AyMINE (C) 2020
- Gestures and Keyboard Shortcuts
- Password retention policy
- framework user rights
- AyMINE — Windows Application
- AyMINE — Tips for Mobile Usage
- Overview of Modules and Record Types
hr
- Human resources
- Worker
- Human Resources module security
- Personalistics – User Permissions and roles
- Manage department / division data
- Synchronizing staff and system users
- Responsible HR Manager
- HR module role
- Registration of job seekers
- An overview of your staff
- Digital Personnel Archive
- Job Position
- Worker overview
Formatted texts in the application
The application supports various internal formats and in some cases gives you a choice of which one to choose.
In a nutshell: Markdown or HTML?
If you don't need font styles and colors, Markdown is preferable. However, if you can't do without colors, you'll have to choose HTML.
There is a choice
The application usually doesn't give you a choice – different formats would create confusion that would outweigh the advantages. Markdown is used by default everywhere, although with a number of extensions.
Currently, the HTML format is used by default only for emails and email message templates. HTML is the standard for email and its conversion into markdown is not practical.
Optionally, HTML can be used for writing information. Other HTML objects can be defined by modules.
Markdown and its properties
Markdown is a standard format, its structure is simpler and does not contain so-called pair tags. As a result, there is no danger of breaking up its structure, as is easily the case with HTML when some extra <div> strays into it.
Markdown benefits
There are a number of good reasons why we consider markdown more appropriate:
- Automatic Translations – sending HTML to compilers is significantly more challenging even for a compiler that tries to keep the HTML structure. The result is not always right, sometimes HMLT compilers can't handle it at all
- Colors – The system allows both light and dark backgrounds to be used, but if users would set internal colors for texts, the inverse display is very problematic. Problems are certainly familiar to anyone who wants to use email in a dark environment.
- Start of text display – It is very easy to view the beginning of a document from a markdown document, e.g. the first paragraphs. With HTML, this is generally not possible without loading the whole document.
- Check boxes and their check – Markdown supports checklists, i.e. a list with check boxes. These can be created in HTML, of course, but their use and searching in markdown is significantly easier. The system automatically checks where checkboxes are not checked, e.g. checks for tasks and convenient filling in. This is why markdown is directly made.
- Automatic Formatting – due to the fact that markdown does not contain formatting in the document, it is easier to display it as it suits the screen and the way it is used.
- Combining different contents – joining multiple markdown documents is significantly easier, there are no problems with different styles.
Not all clean
Unfortunately, markdown in its pure form does not allow, for example, the insertion of pictures or a table. Therefore, the application uses extended syntax, which complements these realistically necessary options.
HTML and why it sometimes has the upper hand
If you need more detailed formatting or save the input from the Internet, "manual formatting" will be more appropriate.
Hand-formatted text is saved in HTML format, used by another editor, which gives other options:
- Align text
- Work better with tables and blocks
- Use font colors
- Use font colors
- Use fonts
¬ ### Risks and disadvantages of HTML
HTML has disadvantages for which it is not used by default. It is good to remember them. Unsurprisingly, these are the main benefits of markdown as listed above.
Font Colors
As mentioned above, font colors are fine, but only as long as everyone displays the text under the same conditions. But keep in mind that half of people use a light background and half use a dark one. If you give some text a red or bright blue color, it's okay. But if you impose e.g. black or on the contrary light grey or any colour on the edges of bright and dark, half of the readers will have a problem with it.
Note: The reason for not using colors is crucial for not using them e.g. in requirements. There is a great risk that the solver may not notice part of the text. Therefore, the application does not support the use of colors in the requirements.
Font style (font)
Font styles help highlight some passages, but as with colors, what you see may not be seen by the reader. For example, mails do not use fonts, or most browsers do not use them by default. Styles in email should therefore not be used at all.
Styles are not transferred to generated PDF documents, either; the generator has its own font sets. Therefore, the highlight you have on the screen will look different in the document.
Styles may not even be available to the reader who receives the information – their font browser does not need to download them; e.g. it is common on mobile phones.