Skip to content

Creating a Better Documentation Experience

ADMIN | 07-12-2012

Creating a Better Documentation Experience

Hexagon pattern 1

The Spatial Product Documentation at doc.spatial.com is quite extensive...ok, let's just say it..."HUGE".

We get that. However, your experience with our product documentation can still be a really good one. And even though our online documentation consists of over 8,000 documents, you'll be pleased to see that the content is well-organized, searchable, and most importantly, helpful.

Hi. My name is Amalia Hurtado and I intend to help you improve your experience with Spatial's product documentation. With a series of blog posts, I plan to shed some light on the best features of our online documentation and help you locate what you need quickly.

Online Product Documentation Highlights
Did you know that Spatial’s online product documentation features . . . 

  • An ACIS Getting Started Guide
  • Multiple tutorials for step-by-step instructions on using ACIS
  • Hundreds of ACIS FAQs and InterOp FAQs that describe how to perform typical functions. Many of these articles provide a C++ code sample, their signature, source files, and any applicable Scheme extensions.
  • A comprehensive listing of ACIS error codes, their descriptions and complexities, while many provide a workaround for the issue
  • Over 1,800 Scheme extensions with examples and images to assist your development efforts, and to troubleshoot issues with Support Services
  • A mapping of Scheme extensions to their corresponding APIs
  • A comprehensive listing of Scheme data types, ACIS options, and Law symbols
  • Archived release notes so that you can easily determine what was developed and changed in previous releases of ACIS, InterOp, and RADF
  • A listing of technical articles that were either new or improved, and articles that describe new product functionality for each release
  • A glossary of key terms used throughout the product documentation
  • And most recently, localized versions of the ACIS R23 Release Notes in Chinese, Japanese, and Korean, and of the InterOp R23 Release Notes in Chinese, Japanese, and Korean
     

Documentation Interface

 

 

 

 

 

 

 

 

 

 

 

 






In my next post I will outline how to best navigate our product documentation through the search engine, with categories, and I'll share some tips and tricks.

You might also like...

5 Min read
CGM Modeler
Software components are like the stage crew at a big concert performance: the audience doesn’t see them, but their...
8 Min read
CGM Modeler
There’s a lot of confusion around what the terms additive manufacturing and 3D printing mean.
2 Min read
CGM Modeler
WRL files are an extension of the Virtual Reality Modeling Language (VRML) format . VRML file types enable browser...
Voxel model example
3 Min read
CGM Modeler
Voxels are to 3D what pixels are to 2D. Firstly -- let’s examine what pixels actually are. Everything you see on your...
Point_cloud_torus
2 Min read
CGM Modeler
Point-cloud modeling is typically used in the process of 3D scanning objects. Rather than defining surfaces through...
Polygonal Modeling
2 Min read
CGM Modeler
Polygonal (or polyhedral) modeling is the most common type of modeling for video games and animation studios. This type...
BREP Model example
2 Min read
CGM Modeler
BRep modeling, or Boundary Representation modeling, is, in CAD applications, the most common type of modeling. BRep is...
Construction site with crane and building-1
3 Min read
3D Software Development Kits
Digital twins are changing the way the construction industry manages large building projects and infrastructure...
3 Min read
3D Software Development Kits
There is a new wave of innovative processes and solutions that improve product production throughput, and enable...
3D Product Visualization.jpg
2 Min read
3D Software Development Kits
In the 3D modeling space, application developers face a number of challenges — getting to market on time, delivering...
General PMI
4 Min read
3D Software Development Kits
It has already been a year since release 2017 1.0, which saw the introduction of a number of innovative features aimed...
Large Tolerant  Vertex
3 Min read
3D Software Development Kits
boolean operation Boolean operations on individual bodies are common functions in 3D modeling. While simple in concept,...
3 Min read
3D Software Development Kits
In much the same way as physical design has moved from paper 2D drawings to 3D models in software, so has analysis....
2 Min read
3D Software Development Kits
Today was day one of Spatial Corp.’s 3D Insiders’ Summit 2016, an educational event that focuses on technical topics...
4 Min read
3D InterOp
Part and parcel with model-based engineering is model translation. Because the model is now the specification, accurate...
3 Min read
3D Software Development Kits
In case you missed the news this week, we announced the availability of Release 2017 1.0 for Spatial software...
2 Min read
3D Software Development Kits
Augmented World Expo 2016
4 Min read
3D Software Development Kits
Make or buy is an age old question for anyone building products, whether hardware or software. For example, for a...