microsoft / microsoft/Documentarian
Create blog post to describe Documentarian
Open
Nobody has claimed this yet.
documentation
enhancement
needs-triage
project-fhlc
- Dominant language
- PowerShell
- Stars
- 50
- Forks
- 16
- Avg merge
- 3h 54m
- Merged PRs (30d)
- 2
Description
Prerequisites
- Accepted Idea: Proposals in this project are created based on ideas that have been marked as
Acceptedin their Discussion. Before you file an issue for new document or a rewrite, create a discussion. If you file an issue without a discussion, the team may convert it into one. - Existing Issue: Search the existing issues and discussions for this repository. If there is an issue or discussion that fits your needs do not file a new one. Subscribe, react, or comment on that issue or discussion instead.
- Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new
Get-Foocmdlet" instead of "New cmdlet."
Module
Documentarian
Summary
We need to describe what Documentarian is for an end user.
- Why would I want to use it?
- What's in it?
- What are our goals for this module?
This should be more marketing focused than technical. This is the elevator pitch.
Details
No response
Proposed Content Type
Other / Unknown
Proposed Title
What is Documentarian
Related Articles
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue summary and the repository description to understand Documentarian's audience, purpose, contents, and goals. Draft the proposed “What is Documentarian” blog post in the project's established documentation location, if one is identified, and consider it done when it provides a clear, marketing-focused elevator pitch for end users.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100