-
Notifications
You must be signed in to change notification settings - Fork 7
Document the technical evaluation process #6817
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devin-ai-integration
wants to merge
5
commits into
main
Choose a base branch
from
devin/1788367703-technical-evaluation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
fern/products/docs/pages/getting-started/technical-evaluation.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: Technical evaluation | ||
| description: How a technical evaluation with the Fern team works, from the demo site through requirements review and approvals. | ||
| --- | ||
|
|
||
| <Markdown src="/snippets/enterprise-plan.mdx"/> | ||
|
|
||
| A technical evaluation is a guided trial of [Fern](/learn/docs/getting-started/capabilities) using your own content. It takes one to three weeks, giving your team time to publish real changes and see what Fern's outputs look and feel like before you commit. | ||
|
|
||
| Your Fern account team runs the evaluation with you. Contact them with questions at any point during the process. | ||
|
|
||
| ## Evaluation stages | ||
|
|
||
| | Stage | Outcome | | ||
| | --- | --- | | ||
| | 1. [Demo site](#demo-site) | Fern stands up a site with representative content, specs, and configuration. | | ||
| | 2. [Hands-on access](#hands-on-access) | Your whole team can edit and publish docs directly. | | ||
| | 3. [Requirements sheet](#requirements-sheet) | A shared, prioritized list of what your docs need. | | ||
| | 4. [Requirements review](#requirements-sheet) | Fern matches the demo to the sheet and walks through it on a call. | | ||
| | 5. [Stakeholder sessions](#stakeholder-sessions) | Each team sees how Fern fits their workflow. | | ||
| | 6. [Approvals](#approvals) | Legal, security, and procurement reviews. | | ||
|
|
||
| ## Demo site | ||
|
|
||
| Fern builds the demo site before the evaluation starts, using representative content from your existing docs, your API specs, and configuration close to what you would ship. | ||
|
|
||
| To get the demo as close to your real site as possible, send your account team: | ||
|
|
||
| - A content export from your existing docs | ||
| - Your API specs | ||
| - Brand assets like your logo, favicon, colors, and fonts | ||
|
|
||
| Send further configuration requests as they come up: versions, products, additional branding, authentication, or anything else the demo needs to represent your real site. | ||
|
|
||
| ## Hands-on access | ||
|
|
||
| Fern gives every participant access to the demo site so your team can go through the publishing flow rather than watch it. Both authoring paths are available: | ||
|
|
||
| - Writers who don't use Git can edit and publish in [Fern Editor](/learn/docs/writing-content/fern-editor). | ||
| - Engineers and writers who prefer Git can clone the repository and work locally against Fern's [project structure](/learn/docs/getting-started/project-structure). The [Docs quickstart](/learn/docs/getting-started/quickstart) covers the CLI, local previews, and publishing. | ||
|
|
||
| ## Requirements sheet | ||
|
|
||
| Fern and your team build a shared requirements document, with each requirement prioritized as a must-have, should-have, or could-have. | ||
|
|
||
| Alongside the requirements, agree on two or three success criteria tied to an outcome you care about, like reader activation, support ticket deflection, or engineering time saved on docs maintenance. That gives the evaluation a clear bar to clear rather than just a feature list. | ||
|
|
||
| Fern then configures the demo site to match the sheet and presents it on a call, going through the requirements one by one so each is either checked off or has a clear path forward. | ||
|
|
||
| ## Stakeholder sessions | ||
|
|
||
| Fern meets with the teams that touch your docs to discuss how Fern fits their existing flows and the outcomes they care about. Which teams join and what each session covers depends on what matters to you. The table below shows common examples: | ||
|
|
||
| | Example team | Example topics | | ||
| | --- | --- | | ||
| | Engineering | [Spec syncing](/learn/api-definitions/openapi/sync-your-open-api-specification), [API Explorer](/learn/docs/api-references/api-explorer) configuration with [SDK snippets](/learn/docs/api-references/sdk-snippets) and [API key injection](/learn/docs/authentication/features/api-key-injection), and how Fern [reduces time to first API call](https://buildwithfern.com/customers/frame). | | ||
| | Marketing | The [SEO, GEO](/learn/docs/seo/overview), and [agentic optimizations](/learn/docs/ai-features/overview) Fern provides to improve discoverability by both agents and humans. | | ||
| | Support | Configuring [Ask Fern](/learn/docs/ai-features/ask-fern/overview) as the first line of support for your users. | | ||
| | Technical writing | Automating docs maintenance with the [Fern Agent](/learn/docs/ai-features/fern-agent), driven by code changes, [user feedback](/learn/docs/customization/user-feedback), support tickets, and [analytics](/learn/docs/integrations/overview). | | ||
|
|
||
| ## Approvals | ||
|
|
||
| Once the requirements are settled, Fern works with your legal, security, and procurement teams through their review processes. The [security overview](/learn/docs/security/overview) covers Fern's architecture, authentication model, and self-hosted options, which are the most common questions in a security review. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.