Sr Technical Software Documentation Consultant (1099)
Xpoint · Philadelphia, PA · 3 wk ago
HybridFull-time
We need to produce HTML fragment with headings
for sections: About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule. Only include sections that have real specific content. We must not repeat job title as heading. Must not include Job ID etc. Must preserve all substantive info, remove boilerplate, navigation, legal, EEO, etc. Must not invent or summarize away detail. Must not include sections with filler like "commensurate with experience". Must only include sections when posting has real specific content.
We need to parse the posting.
Job title: Senior Technical Software Documentation Consultant. Location: Remote. Job Type: Independent Contractor (1099 / Hourly). Engagement: Project-based, hourly.
About Xpoint: description.
The Opportunity: description.
Who It Serves: description.
What You'll Deliver: description.
Scope: Evaluation to Go-Live and Beyond: description.
How You'll Work: description.
What Success Looks Like: description.
What You Bring: description.
Engagement Structure: description.
How to Apply: instructions (should be removed as application instructions). So we must remove application instructions.
We need to map content to sections: About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule.
We need to decide which sections have content.
- About the role: Could be the description of the role (The Opportunity, Who It Serves, What You'll Deliver, Scope, How You'll Work, What Success Looks Like). Might be considered "About the role". We'll put that in About the role section.
- Responsibilities: Could be What You'll Deliver, How You'll Work, etc. Might be separate.
- Requirements: Could be What You Bring (experience, skills). Could be also required qualifications.
- Qualifications: Might be similar to Requirements.
- Skills: Could be technical fluency, writing, etc.
- Benefits: Not mentioned; maybe none. So we should not include Benefits unless present.
- Pay: Engagement mentions hourly rate but not a specific amount; they ask candidate to tell hourly rate. No specific pay given. So we should not include Pay section because no specific pay stated.
- Schedule: Engagement mentions predictable weekly capacity, not full-time required. Could be schedule info: "Full-time availability isn't required, but predictable weekly capacity is." That's schedule info. So we can include Schedule section with that detail.
We must not include sections with filler like "commensurate with experience". So we need to ensure we only include sections with real content.
Thus we will produce sections: About the role, Responsibilities, Requirements, Qualifications, Skills, Schedule.
We need to decide what goes where.
We must preserve all substantive info; not invent or summarize away detail. So we need to include details from the posting.
We need to be careful not to duplicate content across sections unnecessarily, but we can split.
Let's extract substantive content:
About Xpoint: Xpoint provides geolocation and fraud prevention technology for online gaming operators. We help clients meet complex regulatory and operational requirements with reliable geolocation.
The Opportunity: We're looking for a Senior Documentation Consultant to overhaul our client documentation portal. The portal is used by prospective clients evaluating Xpoint and by existing clients integrating and running our platform. You'll own the whole project: discovery, information architecture, writing, validation, publication and handover. The result should be an accurate, easy-to-navigate portal that shows what Xpoint does, helps clients choose the right integration, and guides them to launch and beyond.
Who It Serves: Product Managers need to understand capabilities, use cases, limitations, integration choices and launch planning. Developers and Architects need to choose and implement SDKs and APIs, set up environments, test, troubleshoot and prepare for production. Anti-Fraud and Risk Teams need to understand detection capabilities and limits, controls, reports and investigations. Each audience needs a clear entry point, with shared reference material and consistent terminology. Compliance content must be reviewed by Xpoint's compliance team.
What You'll Deliver: First, an audit of the current portal covering gaps, conflicts, outdated content and recurring client questions, benchmarked against leading developer platforms. Next, a proposed portal structure and phased delivery plan, agreed before the main rewrite, with scope, owners, milestones and acceptance criteria. Then a capability guide and an integration decision guide covering use cases, prerequisites, tradeoffs and the right path for each scenario. Finally, validated and published documentation, plus a maintenance process Xpoint can sustain.
Scope: Evaluation to Go-Live and Beyond: Concepts and capabilities, including dependencies, with a clear line between what's available and what's on the roadmap. Integration paths (on-demand, periodic, companion app), with decision trees and SDK/API responsibilities. Implementation: setup, credentials, configuration, authentication, callbacks, code samples, payloads and diagrams. Testing and launch: sandbox, test scenarios, failure handling, certification and regulatory steps, launch checks, and who owns what. Fraud operations: rules, controls, results, reports, investigation workflows, false positives and escalation. Troubleshooting and change management: error guidance, support evidence, version differences and upgrades.
How You'll Work: You'll work with Product, Engineering, Customer Success, Support, and Fraud and Compliance, and a named internal owner will coordinate access, reviews and approvals. You'll interview subject-matter experts, reconcile conflicting guidance, and verify everything through testing and authoritative sources, flagging gaps rather than filling them with assumptions. You'll design navigation, templates, a glossary and search terminology, writing in layers: approachable for non-technical readers, precise for developers. You'll deliver incrementally and keep a visible tracker of content status, dependencies and open questions. You'll use AI tools to speed up research, drafting, consistency checks and maintenance. All AI-assisted content must be validated and reviewed by subject-matter experts, using only Xpoint-approved tools and following our rules on confidential and client data.
What Success Looks Like: Success is measured by agreed client journeys, not page count. Representative product, developer and fraud readers can complete agreed tasks without undocumented steps. Examples are tested, and capability claims have named reviewers and approval records. The agreed content is published, with no unresolved material contradictions. Xpoint receives editable source content, templates, review ownership and a maintenance process tied to product releases.
What You Bring: A portfolio of documentation portals or major overhauls you personally delivered for SaaS, API or SDK platforms. Hands-on technical fluency: you read code, run sample integrations, inspect requests and responses, and hold your own with engineers. Proven ability to write for both technical and non-technical audiences, with strong information-architecture skills. Experience scoping, estimating and delivering independent consulting engagements. A rigorous approach to accuracy: you test, ask precise questions and resolve contradictions. Strong working knowledge of AI in documentation workflows, including its limits. Nice to have: geolocation, fraud, identity or security, regulated software, usability testing, docs-as-code tooling. Gaming experience helps but isn't essential.
Engagement Structure: This is an independent contractor role, billed hourly against an agreed scope and budget. Full-time availability isn't required, but predictable weekly capacity is. It starts with a discovery and audit phase, with deliverables, dates and maximum hours agreed upfront. The main overhaul needs separate approval of scope, budget and milestones. Ongoing maintenance may be available. Candidates outside the US may be considered, depending on our ability to engage and pay contractors in their location.
We need to remove application instructions (How to Apply). Also remove any boilerplate like EEO etc (none present). Also remove duplicated lines (none obvious). Also remove cookie/navigation/legal etc (none).
Now map to sections.
About the role: Could combine The Opportunity, Who It Serves, What You'll Deliver, Scope, How You'll Work, What Success Looks Like. But we need to avoid too much duplication; but we can put all that in About the role as a comprehensive description. However we also need Responsibilities, Requirements, Qualifications, Skills sections. We could split.
Better: About the role: brief overview of role and company (The Opportunity + About Xpoint). Responsibilities: What You'll Deliver + How You'll Work + Scope (maybe). Requirements: What You Bring (mandatory). Qualifications: maybe similar to Requirements but we could treat Qualifications as education/experience? Not given. Could omit Qualifications if no specific content. Skills: technical fluency, writing, IA, etc. Could be part of What You Bring but we can separate.
We must not create sections with filler. So if we don't have specific content for Qualifications, we should omit it.
Thus we will include: About the role, Responsibilities, Requirements, Skills, Schedule.
We need to check if Benefits, Pay present: none specific, so omit.
Now we need to ensure we preserve all substantive info. If we omit Qualifications, we might lose some info that could be considered qualifications (like "Experience scoping, estimating and delivering independent consulting engagements.") That could be considered a qualification. But we can put that in Requirements or Skills. The instruction says we should not omit substantive info. So we need to ensure all substantive info appears somewhere.
Let's list all substantive info bullets:
- About Xpoint (company description)
- The Opportunity (role purpose)
- Who It Serves (audiences)
- What You'll Deliver (audit, structure, guide, published docs, maintenance process)
- Scope (Evaluation to Go-Live and Beyond) details: concepts/capabilities, integration paths, implementation, testing/launch, fraud ops, troubleshooting/change management.
- How You'll Work (collaboration, SME interviews, navigation design, incremental delivery, AI tools usage, validation)
- What Success Looks Like (client journeys, tested examples, named reviewers, published content, editable source, maintenance process)
- What You Bring (portfolio, technical fluency, writing for both audiences, IA skills, scoping/estimating/delivering independent consulting engagements, rigorous accuracy approach, AI workflow knowledge, nice-to-haves)
- Engagement Structure (independent contractor hourly, predictable weekly capacity, discovery/audit phase, main overhaul approval, ongoing maintenance possible, international candidates considered)
We need to map these to sections.
About the role: Could include About Xpoint, The Opportunity, Who It Serves (audience). That seems appropriate.
Responsibilities: Could include What You'll Deliver, How You'll Work, Scope (maybe). But Scope is more about what the documentation covers, not responsibilities. However responsibilities could be what you will do: deliver audit, propose structure, write guides, validate, publish, work with teams, interview SMEs, design navigation, use AI tools, etc. So we can put those.
Requirements: Could include What You Bring mandatory items: portfolio, technical fluency, writing for both audiences, IA skills, scoping/estimating/delivering independent consulting engagements, rigorous accuracy approach, AI workflow knowledge. Also maybe "Nice to have" items are not requirements.
Skills: Could be technical fluency, writing for both audiences, IA skills, etc. Might overlap with Requirements. But we can separate: Requirements = experience/qualifications; Skills = abilities.
But we need to avoid duplication. However the instruction says preserve ALL substantive information; duplication is okay as long as we don't lose info. But we should avoid unnecessary duplication? Not explicitly forbidden, but we should aim for concise. However we can put some info in multiple sections if it fits.
Better to follow typical resume sections: About the role (summary), Responsibilities (duties), Requirements (mandatory qualifications), Qualifications (preferred?), Skills (specific abilities). Since we don't have separate qualifications, we could omit Qualifications.
Let's decide:
- About the role: company description + role purpose + audiences.
- Responsibilities: list of duties: audit, propose structure, write capability guide & integration decision guide, validated/published docs, maintenance process, work with cross-functional teams, interview SMEs, reconcile guidance, verify via testing, design navigation/templates/glossary/search, incremental delivery tracker, use AI tools (with validation), etc.
- Requirements: mandatory qualifications: portfolio of documentation portals/major overhauls for SaaS/API/SDK platforms; hands-on technical fluency (read code, run sample integrations