Mynd for technical writers
Technical Writer, as it will appear in the app, in the next version.
A technical writer turns technical knowledge into clear documentation. The work is versions, questions to experts and pages that go out of date.
The ready-made structure
Score 88 out of 100. What the score means.
The structure starts with Documentation, the centre of the work, divided into Technical, Product and Knowledge. Then come Writing, Audience, Research, Publishing, Collaboration and AI. Each record keeps its full path, for example Documentation, Technical, Guides, and can be found by any of the three levels.
The full tree is at the end of this page, with the names as they are in the app.
Suggested Context phrases
The structure says what each record is about. The Context phrases, which each person creates, say the rest. For this profession, some that tend to serve:
To update Question for expert Published Feedback
A report that sends itself
A search gathers the pages tagged To update. Every Monday, the writer receives the list.
What you gain: Documentation keeps up with the product.
The card with the style guide goes to everyone who writes documentation.
In this version, Start, each person has 14 automatic search sends and 14 card sends; in Run, they will be able to have as many as they need. Each send has its own search, its own recipients and its own frequency: daily, weekly, monthly or on a date. Emails go out from the person's own email account, and each recipient receives their own.
The full tree
Documentation3 Types
- Documentation/TechnicalGuidesManualsReferences
- Documentation/ProductFeaturesWorkflowsUpdates
- Documentation/KnowledgeProcessesStandardsPolicies
Writing3 Types
- Writing/ContentDraftingEditingReview
- Writing/StructureSectionsTemplatesFormatting
- Writing/LanguageClarityAccuracyConsistency
Audience3 Types
- Audience/UsersBeginnersAdvancedExperts
- Audience/TeamsBusinessTechnicalSupport
- Audience/ChannelsWebPrintTraining
Research3 Types
- Research/RequirementsFeaturesChangesFeedback
- Research/SourcesSMEsSystemsRecords
- Research/AnalysisContentGapsUpdates
Publishing3 Types
- Publishing/PlatformsWebsitesPortalsWikis
- Publishing/DistributionDocumentsArticlesReports
- Publishing/MaintenanceVersionsReviewsArchives
Collaboration3 Types
- Collaboration/DevelopmentRequirementsFeaturesTesting
- Collaboration/BusinessProcessesApprovalsReviews
- Collaboration/SupportIssuesFeedbackSolutions
AI3 Types
- AI/DraftingOutlinesFirstDraftsRewrites
- AI/AssistantsDocsChatAnswersGaps
- AI/ReviewAccuracyTerminologyApproval
