Summary : Busy Silicon Valley software technical writing consultant needs to offload parts of multiple clients' documentation projects.
You'll be briefed on the context, tools, audience, scope, and priorities, supplied with recordings of SME meetings, and work to a tight schedule.
Apply your computer science / software programming experience, demonstrably excellent developer doc writing skills, and willingness to put business first, then deliver quality work when promised.
You'll be taught the rest. This is a rare chance to do great developer doc while working 100 percent offsite.
Audience : Software developers for a variety of complex open-source products Tasks : As directed, contribute to original developer-oriented software documentation such as API references, quick-starts, and tutorials.
Project Lead is a technical writing consultant with a Ph.D. in Computer Science who values character, integrity, and trustworthiness as much as quality work, reliability, and productivity.
This role requires less initiative and more adherence / obedience than most senior roles; if you won't follow directions, please don't apply.
Tools : Vary by client. Usually open-source tools like Markdown and Git, static site generators (like Hugo, Sphinx, and Jekyll), and autogenerated content publishing tools (like Readme.
io, Developer Program, Swagger / Open API Spec). You must work on a recent model Mac; a Windows PC isn't sufficient. Soft Skills : Positive, energetic, can-do attitude and bias for action (as opposed to research).
Being self-motivated and able to think on your feet are essential. So are a willingness to jump in, install the product and / or read the source code, then deliver clear, concise, correct, complete documentation.
Team : You'd be one of this consultant's unofficial ghostwriters on multiple fast-paced client documentation projects. Note : you won't be able to claim formal credit for working on specific clients' projects.
Starts : ASAP Duration : Typically 15-20 hrs / week, but up to 40 hrs / week if supply permits and you're willing. Indefinite.
Relo / Visa help : No. Strongly prefer a US social security number or corporate tax ID number, with a US bank account. In exceptional cases, will engage a foreign national and compensate with US $-denominated Amazon gift cards.
Representation : Principals only, please
Required :
- Working knowledge of object-oriented and / or functional software programming language(s), e.g., C++, Java, Python, JavaScript, Go
- Familiarity with autogenerated-content authoring environments, e.g., Readme.io, Developer Program, Stoplight.io, Swagger / OAS
- Mastery of oral and written North American Business English
- Strong research, analytical, problem-solving, and interpersonal skills
- Shareable portfolio of developer-oriented content, preferably for open-source projects
- Proven mathematical and computer science background and competence
- Ethical, trustworthy, reliable character
This is a part-time (typically 15-20 hours / week), contract role that pays $50 / hr on a 1099 basis or $42 / hr on W2. In the latter case, it includes the option of benefits such as a 401(k) plan, expense reimbursement, and full (self-paid) insurance coverage.